Create dictionary (create)

Create a new user dictionary.

Create a new dictionary.

Parameters

These parameters work with any cmd.

Name	Type	Required	Description
serviceid	string	Cloud only	Cloud API key. Required for Cloud requests. Not used on-premises.
format	string	No	Response format. Values: json (default), xml.
callback	string	No	JSONP wrapper function name. Use only with format=json.
short_answer	boolean	No	JSON only. When true, shortens JSON keys to reduce payload size. See boolean parameters.

See Overview for details.

Command specific parameters

Parameter	Type	Required	Default	Notes
cmd	string	Yes	user_dictionary	Command name.
action	string	Yes	create	Action name.
name	string	Yes		Dictionary name to create.
wordlist	string	No		Optional comma-separated initial words.

Behavior

• Creates a new dictionary.

• Adds wordlist words if provided.

create fails if the dictionary already exists.

Use addword(s) if you want auto-create behavior.

Response

Returns the created dictionary state.

See Response format.

Errors

Common errors:

• Dictionary already exists.

• Dictionary name is missing, invalid, or longer than 50 characters.

• If wordlist is present:

  • a word is empty

  • a word contains forbidden symbols

  • a word is longer than 63 characters

See Errors reference.

Examples

Create an empty dictionary

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "create",
  "name": "my_dict"
}

Response (JSON):

{
  "name": "my_dict",
  "action": "create",
  "wordlist": [],
  "modificationTime": 1772124021
}

Create a dictionary with initial words

Request body (JSON):

{
  "cmd": "user_dictionary",
  "action": "create",
  "name": "my_dict",
  "wordlist": "API,SDK"
}

Response (JSON):

{
  "name": "my_dict",
  "action": "create",
  "wordlist": ["API", "SDK"],
  "modificationTime": 1772124021
}