User custom dictionary API

Overview of user custom dictionary API

Use the User Dictionary API to manage end-user wordlists.

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

Dictionary size is limited. One dictionary is capped at 50 KB (about 10k words).

Actions

Action

Create dictionary

Docs

Create dictionary (create)

Action

Delete dictionary

Docs

Delete dictionary (delete)

Action

Rename dictionary

Docs

Rename dictionary (rename)

Action

Check dictionary

Docs

Check dictionary (check)

Action

Add word(s)

Docs

Add word(s) (addword, addwords)

Action

Delete word(s)

Docs

Delete word(s) (deleteword, deletewords)

Action

Edit word

Docs

Edit word (editword)

Action

Get dictionary content

Docs

Get dictionary content (getdict)

Action

Replace dictionary content

Docs

Replace dictionary content (setdict)