# Parameters reference

This API uses `cmd=user_dictionary`.

Actions are selected via `action`.

### 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         | <p>JSON only. When <code>true</code>, shortens JSON keys to reduce payload size.<br>See <a href="/pages/VXTsQ0sY5BFRLUsqxnbL#boolean-parameter-values">boolean parameters</a>.</p> |

See [Overview](/api-reference/overview.md#common-parameters) for details.

#### Command specific parameters

| Parameter  | Type   | Required | Used by                                                       | Notes                                                                                                           |
| ---------- | ------ | -------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `cmd`      | string | Yes      | all                                                           | Always `user_dictionary`.                                                                                       |
| `action`   | string | Yes      | all                                                           | One of: `create`, `delete`, `rename`, `check`, `addword(s)`, `deleteword(s)`, `editword`, `getdict`, `setdict`. |
| `name`     | string | Yes      | all                                                           | Dictionary name to operate on.                                                                                  |
| `new_name` | string | Yes      | `rename`                                                      | New dictionary name.                                                                                            |
| `word`     | string | Yes\*    | `addword(s)`, `deleteword(s)`, `editword`                     | Single word. For `editword`, this is the old word.                                                              |
| `new_word` | string | Yes      | `editword`                                                    | Replacement word value.                                                                                         |
| `wordlist` | string | Yes\*    | `create` (optional), `addword(s)`, `deleteword(s)`, `setdict` | Comma-separated words. See precedence rules below.                                                              |

\* Required depends on the action.

### `word` vs `wordlist` precedence

For `addword(s)` and `deleteword(s)`:

* If `wordlist` is present and not empty, it takes precedence.
* Otherwise, `word` is used.

### Validation and limits

#### Dictionary names (`name`, `new_name`)

* Must not be empty.
* Max **50** characters.
* Allowed characters: **Latin letters**, **digits**, **underscores**.
* `new_name` must differ from `name`.

#### Words (`word`, `new_word`, `wordlist`)

* Max **63** characters per word.
* No spaces.
* No punctuation or special characters.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/parameters-reference.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.