The Vocabulary API manages the words your organization wants transcripts to get right: product names, people, places and jargon. Words live as entries, either private to one person or in a vocabulary list that can be shared.
- Private entries — Words only their owner's transcripts use. Create one with
list_idset to null. - Organization list — Every organization has one list that every member reads. It cannot be deleted.
- Custom lists — Lists a person creates and owns, optionally in a team space. Share a custom list with people, teams, departments or the whole organization by creating an access grant on it.
- Rights — Every list and entry in a response says what the caller may do with it (
can_edit,can_share,can_delete). A list or entry the caller cannot read answers 404; one they can read but not change answers 403. - Suggestions — Words proposed for the shared vocabulary: members' names, assistant and project names, and words several colleagues learned from their own corrections. People who manage the team vocabulary approve or dismiss them.
- Settings — Organization-wide switches for learning from corrections and sharing learned words. Every member may read them; only people who manage the team vocabulary may change them, and every change names the
revisionit was based on.
Create a list and add a word to it:
POSThttps://api.aitronos.com/v1/vocabulary/lists
curl -X POST "https://api.aitronos.com/v1/vocabulary/lists" \
-H "X-API-Key: $FREDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Product names"}'
curl -X POST "https://api.aitronos.com/v1/vocabulary/entries" \
-H "X-API-Key: $FREDDY_API_KEY" \
-H "Content-Type: application/json" \
-d '{"list_id": "voclist_8f2a61c4e0b94d7a", "written": "Kubernetes", "sounds_like": ["cube ernetes"]}'| Endpoint | Description |
|---|---|
| List vocabulary lists | Every list the caller can read, the organization list first |
| Create a vocabulary list | Create a custom list |
| Get a vocabulary list | One list the caller can read |
| Update a vocabulary list | Rename, describe, switch off or move a list |
| Delete a vocabulary list | Delete a custom list and its entries |
| List vocabulary entries | Page private, list or shared entries |
| Create a vocabulary entry | Add a private entry or an entry to a list |
| Get a vocabulary entry | One entry the caller can read |
| Update a vocabulary entry | Change an entry |
| Delete a vocabulary entry | Delete an entry |
| Undo a learned vocabulary entry | Remove a word learned from a correction |
| Import words into a vocabulary list | Add and update words from an .xlsx or .csv file |
| Export a vocabulary list | Download a list as .xlsx or .csv |
| Preview vocabulary | Which words a call would use, and what each model keeps |
| List vocabulary suggestions | Words proposed for the organization's vocabulary |
| Refresh vocabulary suggestions | Collect new suggestions now |
| Approve a vocabulary suggestion | Write a suggested word into a list |
| Dismiss a vocabulary suggestion | Never suggest a word again |
| Approve or dismiss vocabulary suggestions in bulk | Decide up to 100 suggestions at once |
| Get vocabulary settings | Read the organization's vocabulary settings |
| Update vocabulary settings | Change the organization's vocabulary settings |
- Create an access grant — Share a vocabulary list.