> For the complete documentation index, see [llms.txt](https://docs.wproofreader.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.wproofreader.com/v6.16.0/api-reference/user-custom-dictionary-api.md).

# User custom dictionary API

Overview of user custom dictionary API

Use the User Dictionary API to manage [**end-user wordlists**](broken://pages/wUtvaCTReVmwdJNgIrJ9).

Words in a user dictionary are treated as **correct** during spellcheck.

### What you can do

* Create and delete dictionaries.
* Add, delete, and edit words.
* Rename dictionaries.
* Check dictionary availability.
* Fetch a dictionary wordlist.
* Replace a dictionary wordlist.

### When to use this vs custom Dictionary

Use **User dictionary** when the wordlist is:

* Owned by an end user
* Mutable at runtime
* Not tied to a language

Use [Custom dictionary API](/v6.16.0/api-reference/custom-dictionary-api.md) when the wordlist is:

* Owned by your organization
* Shared across many users
* Managed by admins

### Naming rules and limits

Dictionary name rules:

* Max **50** characters
* Use **Latin letters**, **digits**, and **underscores**

Word rules:

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

{% hint style="info" %}
Dictionary size is limited. One dictionary is capped at **50 KB** (about **10k words**).
{% endhint %}

### Actions

<table data-view="cards"><thead><tr><th>Action</th><th data-type="content-ref">Docs</th></tr></thead><tbody><tr><td>Create dictionary</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/create-dictionary-create.md">Create dictionary (create)</a></td></tr><tr><td>Delete dictionary</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/delete-dictionary-delete.md">Delete dictionary (delete)</a></td></tr><tr><td>Rename dictionary</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/rename-dictionary-rename.md">Rename dictionary (rename)</a></td></tr><tr><td>Check dictionary</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/check-dictionary-check.md">Check dictionary (check)</a></td></tr><tr><td>Add word(s)</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/add-word-s-addword-addwords.md">Add word(s) (addword, addwords)</a></td></tr><tr><td>Delete word(s)</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/delete-word-s-deleteword-deletewords.md">Delete word(s) (deleteword, deletewords)</a></td></tr><tr><td>Edit word</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/edit-word-editword.md">Edit word (editword)</a></td></tr><tr><td>Get dictionary content</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/get-dictionary-content-getdict.md">Get dictionary content (getdict)</a></td></tr><tr><td>Replace dictionary content</td><td><a href="/v6.16.0/api-reference/user-custom-dictionary-api/actions/replace-dictionary-content-setdict.md">Replace dictionary content (setdict)</a></td></tr></tbody></table>