# API reference

- [Overview](https://docs.wproofreader.com/api-reference/overview.md): Endpoints, request format, and parameters common to all HTTP API commands.
- [HTTP response status codes](https://docs.wproofreader.com/api-reference/http-response-status-codes.md)
- [Check API](https://docs.wproofreader.com/api-reference/check-api.md)
- [Spelling autocorrect API](https://docs.wproofreader.com/api-reference/spelling-autocorrect-api.md)
- [Text autocomplete API](https://docs.wproofreader.com/api-reference/text-autocomplete-api.md)
- [Custom dictionary API](https://docs.wproofreader.com/api-reference/custom-dictionary-api.md): Manage shared, organization-owned spellcheck dictionaries.
- [Overview](https://docs.wproofreader.com/api-reference/custom-dictionary-api/overview.md): What Custom Dictionary is, when to use it, and core concepts.
- [Getting started](https://docs.wproofreader.com/api-reference/custom-dictionary-api/getting-started.md): Create a dictionary, add words, and verify the result.
- [Actions](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions.md): One page per action for the Custom Dictionary API.
- [Create dictionary (create)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/create-dictionary-create.md): Create a new custom dictionary.
- [Delete dictionary (delete)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/delete-dictionary-delete.md): Permanently delete one or more dictionaries.
- [Add list of words (addwords)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/add-list-of-words-addwords.md): Add words to a dictionary, or overwrite its entire wordlist.
- [Remove words (deletewords)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/remove-words-deletewords.md): Remove words from a dictionary.
- [Get words from dictionary (getwords)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/get-words-from-dictionary-getwords.md): Fetch the full wordlist for a dictionary.
- [List dictionaries (getdicts)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/list-dictionaries-getdicts.md): List dictionaries or fetch metadata for specific IDs.
- [Edit dictionary metadata (edit)](https://docs.wproofreader.com/api-reference/custom-dictionary-api/actions/edit-dictionary-metadata-edit.md): Rename a dictionary or enable/disable it.
- [Parameters reference](https://docs.wproofreader.com/api-reference/custom-dictionary-api/parameters-reference.md): Full parameter list, validation rules, and which actions use each parameter.
- [Response format](https://docs.wproofreader.com/api-reference/custom-dictionary-api/response-format.md): Standard response structure and field meanings.
- [Errors reference](https://docs.wproofreader.com/api-reference/custom-dictionary-api/errors-reference.md): Error messages, HTTP codes, and when they happen.
- [User custom dictionary API](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api.md): Overview of user custom dictionary API
- [Getting started](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/getting-started.md): Create a dictionary, add words, and verify it works.
- [Actions](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions.md)
- [Create dictionary (create)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/create-dictionary-create.md): Create a new user dictionary.
- [Delete dictionary (delete)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/delete-dictionary-delete.md): Permanently delete a user dictionary.
- [Rename dictionary (rename)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/rename-dictionary-rename.md): Rename an existing user dictionary.
- [Check dictionary (check)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/check-dictionary-check.md): Verify a dictionary exists and is accessible.
- [Add word(s) (addword, addwords)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/add-word-s-addword-addwords.md): Add one word or a wordlist to a user dictionary.
- [Delete word(s) (deleteword, deletewords)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/delete-word-s-deleteword-deletewords.md): Remove one word or a wordlist from a user dictionary.
- [Edit word (editword)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/edit-word-editword.md): Replace an existing word with a new value.
- [Get dictionary content (getdict)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/get-dictionary-content-getdict.md): Return all words in a user dictionary.
- [Replace dictionary content (setdict)](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/actions/replace-dictionary-content-setdict.md): Replace the entire wordlist in a dictionary.
- [Parameters reference](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/parameters-reference.md): Complete parameter list, validation rules, and where each parameter is used.
- [Response format](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/response-format.md): Success envelope and field semantics for user dictionary actions.
- [Errors reference](https://docs.wproofreader.com/api-reference/user-custom-dictionary-api/errors-reference.md): Error messages, HTTP statuses, and common failure causes.
- [Detect language API](https://docs.wproofreader.com/api-reference/detect-language-api.md)
- [Auxiliary API commands](https://docs.wproofreader.com/api-reference/auxiliary-api-commands.md)
- [Get info API](https://docs.wproofreader.com/api-reference/auxiliary-api-commands/get-info-api.md)
- [Status API](https://docs.wproofreader.com/api-reference/auxiliary-api-commands/status-api.md)
- [Version API](https://docs.wproofreader.com/api-reference/auxiliary-api-commands/version-api.md)
- [Health check](https://docs.wproofreader.com/api-reference/auxiliary-api-commands/health-check.md)
- [Legacy API commands](https://docs.wproofreader.com/api-reference/legacy-api-commands.md)
- [Check spelling API](https://docs.wproofreader.com/api-reference/legacy-api-commands/check-spelling-api.md)
- [Grammar check API](https://docs.wproofreader.com/api-reference/legacy-api-commands/grammar-check-api.md)
- [Style guide API](https://docs.wproofreader.com/api-reference/style-guide-api.md)
- [Actions](https://docs.wproofreader.com/api-reference/style-guide-api/actions.md)
- [Add rule (addrule)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/add-rule-addrule.md): Create a new style guide rule.
- [Edit rule (editrule)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/edit-rule-editrule.md): Update an existing style guide rule.
- [Delete rule(s) (deleterule, deleterules)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/delete-rule-s-deleterule-deleterules.md): Delete one or multiple style guide rules.
- [Get rules (getrules)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/get-rules-getrules.md): List style guide rules, optionally filtered by rule ID.
- [Add collection (addcollection)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/add-collection-addcollection.md): Create a new style guide collection.
- [Delete collection (deletecollection)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/delete-collection-deletecollection.md): Create a new style guide collection.
- [Get collections (getcollections)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/get-collections-getcollections.md): Create a new style guide collection.
- [Edit collection (editcollections)](https://docs.wproofreader.com/api-reference/style-guide-api/actions/edit-collection-editcollections.md): Create a new style guide collection.
- [Response schema](https://docs.wproofreader.com/api-reference/style-guide-api/response-schema.md): Success envelope and rule object schema for the Style guide API.
- [Errors](https://docs.wproofreader.com/api-reference/style-guide-api/errors.md): Error messages and HTTP statuses for Style guide API.
- [Validation & limits](https://docs.wproofreader.com/api-reference/style-guide-api/validation-and-limits.md): Input validation rules and service limits for Style guide API.


---

# 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.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.
