Create dictionary (create)

Create a new custom dictionary.

Creates a new dictionary.

The server assigns the numeric dictionary id.

What it does

  • Creates an empty dictionary, or seeds it with an initial wordlist.

  • Binds the dictionary to a lang.

  • Enforces unique description per account.

Required parameters

Parameter
Type
Notes

cmd

string

custom_dictionary

action

string

create

lang

string

Example: en_US

description

string

Must be unique per account

Optional parameters

Parameter
Type
Notes

wordlist

string

Comma-separated words to seed the dictionary

format

string

json (default) or xml

callback

string

JSONP wrapper (JSON only)

circle-info

Do not pass id in a create request. The server assigns it.

Request example

Response example

Possible errors

  • Description already used: see Errors reference.

  • Dictionary limit exceeded (HTTP 403).

  • Dictionary file too large (HTTP 409).

Notes and edge cases

  • wordlist is optional.

  • Words already recognized as correct can be filtered out.

  • Save the returned id. All follow-up actions need it.

Last updated

Was this helpful?