{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-docs/api-reference/sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["api-container","api-content","endpoint","api-examples","tabs","tab","code-group"]},"redocly_category":"API Reference","searchWeight":120,"type":"markdown"},"seo":{"title":"Update a vocabulary entry","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":"update-a-vocabulary-entry","__idx":0},"children":["Update a vocabulary entry"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Change an entry's written or spoken forms, language, kind, weight, enabled switch or visibility. Send only the fields to change. Needs edit rights on the entry."]},{"$$mdtype":"Tag","name":"ApiContainer","attributes":{},"children":[{"$$mdtype":"Tag","name":"ApiContent","attributes":{},"children":[{"$$mdtype":"Tag","name":"Endpoint","attributes":{"method":"PATCH","path":"https://api.aitronos.com/v1/vocabulary/entries/{entry_id}"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"path-parameters","__idx":1},"children":["Path Parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["entry_id"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#ef4444 !important","fontWeight":"600 !important","fontStyle":"normal !important"}},"children":["required"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The entry ID."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"request-body","__idx":2},"children":["Request Body"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["written"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How the word is written, 1 to 100 characters."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sounds_like"]}]}," array of string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Replaces every spoken form; up to 10."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A language tag; an explicit null means all languages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kind"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bias"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["replace"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weight"]}]}," number ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How strongly the word is favoured, above 0 and up to 10."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]}," boolean ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the entry is used in transcripts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibility"]}]}," string ",{"$$mdtype":"Tag","name":"em","attributes":{"style":{"color":"#9ca3af !important","fontWeight":"500 !important","fontStyle":"normal !important"}},"children":["optional"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For an entry in a list: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restricted"]},"."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"returns","__idx":3},"children":["Returns"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The updated vocabulary entry:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["id"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The entry ID: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pdict_…"]}," for a private entry, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tdict_…"]}," for one in a list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["scope"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["personal"]}," for a private entry, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}," for an entry in a list."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list_id"]}]}," string or null"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The list the entry belongs to, if any."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["written"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How the word is written."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["sounds_like"]}]}," array of string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How the word may be spoken or misheard."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["language"]}]}," string or null"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The language tag; null for all languages."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["kind"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["bias"]}," makes the word more likely to be recognised; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["replace"]}," also rewrites the spoken forms to the written form."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["source"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How the entry was created."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["weight"]}]}," number"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How strongly the word is favoured, above 0 and up to 10."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enabled"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the entry is used in transcripts."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["visibility"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["private"]}," for a private entry; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["list"]}," when everyone who reads the list sees it; ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["restricted"]}," when only the people it is shared with see it."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["shared"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the entry is shared on its own."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["owner_user_id"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The person who created the entry."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["reached_through"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["How the entry reached the caller."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can_edit"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the caller may change the entry."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["can_share"]}]}," boolean"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Whether the caller may share the entry."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["stats"]}]}," object"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Usage counters: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["applied_count"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["heard_count"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["corrected_count"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last_applied_at"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["last_heard_at"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["created_at"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the entry was created."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["updated_at"]}]}," string"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["When the entry last changed."]}]},{"$$mdtype":"Tag","name":"ApiExamples","attributes":{},"children":[{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"div","attributes":{"label":"Example","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeGroup","attributes":{"mode":"dropdown"},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","data-title":"cURL","header":{"title":"cURL","controls":{"copy":{}}},"source":"curl -X PATCH \"https://api.aitronos.com/v1/vocabulary/entries/tdict_5a9c2e7b1d3f4068\" \\\n  -H \"X-API-Key: $FREDDY_API_KEY\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"sounds_like\": [\"cube ernetes\", \"kuber netties\", \"kubernetis\"]}'\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"python","data-title":"Python","header":{"title":"Python","controls":{"copy":{}}},"source":"import os\nimport requests\n\napi_key = os.environ[\"FREDDY_API_KEY\"]\n\nresponse = requests.patch(\n    \"https://api.aitronos.com/v1/vocabulary/entries/tdict_5a9c2e7b1d3f4068\",\n    headers={\"X-API-Key\": api_key},\n    json={\"sounds_like\": [\"cube ernetes\", \"kuber netties\", \"kubernetis\"]},\n)\n\nprint(response.json())\n","lang":"python"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"javascript","data-title":"JavaScript","header":{"title":"JavaScript","controls":{"copy":{}}},"source":"const apiKey = process.env.FREDDY_API_KEY;\n\nconst response = await fetch('https://api.aitronos.com/v1/vocabulary/entries/tdict_5a9c2e7b1d3f4068', {\n  method: 'PATCH',\n  headers: {\n    'X-API-Key': apiKey,\n    'Content-Type': 'application/json'\n  },\n  body: JSON.stringify({\"sounds_like\": [\"cube ernetes\", \"kuber netties\", \"kubernetis\"]})\n});\n\nconst data = await response.json();\nconsole.log(data);\n","lang":"javascript"},"children":[]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Response:"]}]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"200 OK","header":{"title":"200 OK","controls":{"copy":{}}},"source":"{\n  \"id\": \"tdict_5a9c2e7b1d3f4068\",\n  \"scope\": \"list\",\n  \"list_id\": \"voclist_8f2a61c4e0b94d7a\",\n  \"written\": \"Kubernetes\",\n  \"sounds_like\": [\n    \"cube ernetes\",\n    \"kuber netties\",\n    \"kubernetis\"\n  ],\n  \"language\": null,\n  \"kind\": \"bias\",\n  \"source\": \"manual\",\n  \"weight\": 1.0,\n  \"enabled\": true,\n  \"visibility\": \"list\",\n  \"shared\": false,\n  \"owner_user_id\": \"usr_3c91d0a2b7e4\",\n  \"reached_through\": \"owner\",\n  \"can_edit\": true,\n  \"can_share\": true,\n  \"stats\": {\n    \"applied_count\": 14,\n    \"heard_count\": 9,\n    \"corrected_count\": 0,\n    \"last_applied_at\": \"2026-10-24T09:30:00Z\",\n    \"last_heard_at\": \"2026-10-24T09:30:00Z\"\n  },\n  \"created_at\": \"2026-10-24T09:30:00Z\",\n  \"updated_at\": \"2026-10-24T09:30:00Z\"\n}\n","lang":"json"},"children":[]}]},{"$$mdtype":"Tag","name":"div","attributes":{"label":"Errors","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"401 Unauthorized","header":{"title":"401 Unauthorized","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"AUTHENTICATION_REQUIRED\",\n    \"message\": \"Authentication required. Please provide a valid API key.\",\n    \"system_message\": \"Missing or invalid authorization header\",\n    \"type\": \"authentication_error\",\n    \"status\": 401,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"403 Forbidden","header":{"title":"403 Forbidden","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"INSUFFICIENT_PERMISSIONS\",\n    \"message\": \"You do not have permission to perform this action.\",\n    \"system_message\": \"Caller lacks the rights this operation needs.\",\n    \"type\": \"authorization_error\",\n    \"status\": 403,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"404 Not Found","header":{"title":"404 Not Found","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"VOCABULARY_ENTRY_NOT_FOUND\",\n    \"message\": \"This vocabulary entry does not exist or you cannot see it.\",\n    \"system_message\": \"Vocabulary entry not found.\",\n    \"type\": \"client_error\",\n    \"status\": 404,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","data-title":"409 Conflict","header":{"title":"409 Conflict","controls":{"copy":{}}},"source":"{\n  \"success\": false,\n  \"error\": {\n    \"code\": \"DICTIONARY_TERM_DUPLICATE\",\n    \"message\": \"This word is already in this vocabulary.\",\n    \"system_message\": \"Duplicate term in the same place and language.\",\n    \"type\": \"client_error\",\n    \"status\": 409,\n    \"details\": {},\n    \"trace_id\": \"req_7d1e4b9a2c\",\n    \"timestamp\": \"2026-10-24T09:30:00Z\"\n  }\n}\n","lang":"json"},"children":[]}]}]}]}]},{"$$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/vocabulary/_index"},"children":["Vocabulary API"]}," — Overview of lists, entries and settings."]},{"$$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 with people, teams or the whole organization."]}]}]},"headings":[{"value":"Update a vocabulary entry","id":"update-a-vocabulary-entry","depth":1},{"value":"Path Parameters","id":"path-parameters","depth":4},{"value":"Request Body","id":"request-body","depth":4},{"value":"Returns","id":"returns","depth":2},{"value":"Related Resources","id":"related-resources","depth":2}],"frontmatter":{"title":"Update a vocabulary entry","keywords":["update a vocabulary entry","patch","update","a","vocabulary","entry"],"seo":{"title":"Update a vocabulary entry"}},"lastModified":"2026-10-25T12:39:00.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/docs/api-reference/vocabulary/update-a-vocabulary-entry","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}