> 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.10.0.0/features/custom-dictionary.md).

# Custom dictionary

**Custom dictionaries** allow you to extend the standard spell-check vocabulary with words specific to your organization, industry, or personal workflow, such as brand names, acronyms, technical terms, and proper names.

Words added to a custom dictionary are treated as correct during spell check. With the algorithmic spelling engine, dictionary words also appear in the suggestions list when a similar word is misspelled. With AI-based spelling, dictionary words won't be flagged as incorrect but won't appear as suggestions.

### Types of custom dictionaries

WProofreader provides two types of custom dictionaries designed for different use cases: **user dictionary** and **organization custom dictionary**.

|                             | User dictionary                                                                                                                                                                                   | Organization dictionary                                                                       |
| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| **Purpose**                 | Personal wordlist owned by an end user                                                                                                                                                            | Shared wordlist managed by admins, intended to cover terminology used across the organization |
| **Scope**                   | Personal by default. Visible only to the user who created it. However, if an admin predefines the same dictionary name for multiple users via config, those users will share a single dictionary. | Applies to all users in the subscription or to targeted user groups                           |
| **Language dependency**     | Language-agnostic. Works across all enabled languages.                                                                                                                                            | Language-dependent. One dictionary per language.                                              |
| **Where managed**           | Product UI (WProofreader / SCAYT) or API                                                                                                                                                          | Cloud: admin panel (app.wproofreader.com) or API. Self-hosted: config files or API.           |
| **Can be enabled/disabled** | Yes. Via connect/disconnect in the product UI, or programmatically by setting/removing `userDictionaryName`.                                                                                      | Yes. Via status toggle in the admin panel, or programmatically via API.                       |
| **API command name**        | `user_dictionary`                                                                                                                                                                                 | `custom_dictionary`                                                                           |
| **Max dictionaries**        | Unlimited, but only one active at a time per user                                                                                                                                                 | 50 per account                                                                                |
| **Max dictionary size**     | 50 KB (approximately 10,000 words)                                                                                                                                                                | 500 KB per dictionary (approximately 100,000 English words; varies by language)               |
| **Word rules**              | Max 63 characters. No spaces. No dots at start or end. No punctuation or special characters.                                                                                                      | Same                                                                                          |
| **Dictionary naming**       | Latin characters and/or digits only. Must be unique.                                                                                                                                              | Same. Max 50 characters.                                                                      |

### Which one should you use?

**Use a user dictionary when the wordlist is:**

* Owned by an individual end user
* Managed and accessible by the user directly from the product UI (adding, deleting words, and so on)
* Modified at runtime as the user works
* Not tied to a specific language

**Use an organization dictionary when the wordlist is:**

* Shared across many users
* Managed by admins or automation
* Split by language
* Part of a structured workflow (create, enable/disable, audit, delete)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://docs.wproofreader.com/v6.10.0.0/features/custom-dictionary.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.