{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["api-container","endpoint"]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Vocabulary API","description":"Complete API reference and documentation for Freddy AI-powered backend system by Aitronos","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"vocabulary-api","__idx":0},"children":["Vocabulary API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"key-concepts","__idx":1},"children":["Key concepts"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Private entries"]}," — Words only their owner's transcripts use. Create one with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list_id"]}," set to null."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Organization list"]}," — Every organization has one list that every member reads. It cannot be deleted."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Rights"]}," — Every list and entry in a response says what the caller may do with it (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can_edit"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can_share"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can_delete"]},"). A list or entry the caller cannot read answers 404; one they can read but not change answers 403."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["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 ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["revision"]}," it was based on."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"quickstart","__idx":2},"children":["Quickstart"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a list and add a word to it:"]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"POST","path":"https://api.aitronos.com/v1/vocabulary/lists"},"children":[]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"curl -X POST \"https://api.aitronos.com/v1/vocabulary/lists\" \\\n  -H \"X-API-Key: $FREDDY_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"name\": \"Product names\"}'\n\ncurl -X POST \"https://api.aitronos.com/v1/vocabulary/entries\" \\\n  -H \"X-API-Key: $FREDDY_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"list_id\": \"voclist_8f2a61c4e0b94d7a\", \"written\": \"Kubernetes\", \"sounds_like\": [\"cube ernetes\"]}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"endpoints","__idx":3},"children":["Endpoints"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Endpoint"},"children":["Endpoint"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/list-vocabulary-lists"},"children":["List vocabulary lists"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Every list the caller can read, the organization list first"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/create-a-vocabulary-list"},"children":["Create a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create a custom list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/get-a-vocabulary-list"},"children":["Get a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One list the caller can read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/update-a-vocabulary-list"},"children":["Update a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Rename, describe, switch off or move a list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/delete-a-vocabulary-list"},"children":["Delete a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete a custom list and its entries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/list-vocabulary-entries"},"children":["List vocabulary entries"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Page private, list or shared entries"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/create-a-vocabulary-entry"},"children":["Create a vocabulary entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add a private entry or an entry to a list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/get-a-vocabulary-entry"},"children":["Get a vocabulary entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["One entry the caller can read"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/update-a-vocabulary-entry"},"children":["Update a vocabulary entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change an entry"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/delete-a-vocabulary-entry"},"children":["Delete a vocabulary entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Delete an entry"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/undo-a-learned-vocabulary-entry"},"children":["Undo a learned vocabulary entry"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Remove a word learned from a correction"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/import-words-into-a-vocabulary-list"},"children":["Import words into a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Add and update words from an ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".xlsx"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".csv"]}," file"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/export-a-vocabulary-list"},"children":["Export a vocabulary list"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Download a list as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".xlsx"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":[".csv"]}]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/preview-vocabulary"},"children":["Preview vocabulary"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Which words a call would use, and what each model keeps"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/list-vocabulary-suggestions"},"children":["List vocabulary suggestions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Words proposed for the organization's vocabulary"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/refresh-vocabulary-suggestions"},"children":["Refresh vocabulary suggestions"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Collect new suggestions now"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/approve-a-vocabulary-suggestion"},"children":["Approve a vocabulary suggestion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Write a suggested word into a list"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/dismiss-a-vocabulary-suggestion"},"children":["Dismiss a vocabulary suggestion"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Never suggest a word again"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/approve-or-dismiss-vocabulary-suggestions-in-bulk"},"children":["Approve or dismiss vocabulary suggestions in bulk"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Decide up to 100 suggestions at once"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/get-vocabulary-settings"},"children":["Get vocabulary settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Read the organization's vocabulary settings"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/vocabulary/update-vocabulary-settings"},"children":["Update vocabulary settings"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Change the organization's vocabulary settings"]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related-resources","__idx":4},"children":["Related Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/api-reference/access-control/create-grant"},"children":["Create an access grant"]}," — Share a vocabulary list."]}]}]},"headings":[{"value":"Vocabulary API","id":"vocabulary-api","depth":1},{"value":"Key concepts","id":"key-concepts","depth":2},{"value":"Quickstart","id":"quickstart","depth":2},{"value":"Endpoints","id":"endpoints","depth":2},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Vocabulary API","seo":{"title":"Vocabulary API"}},"lastModified":"2026-10-26T18:31:40.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/vocabulary/_index","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}