curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases \ -H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \ -H "API-Version: 1" \ -H "Content-Type: application/json" \ -d '{ "name": "refund_policy", "instruction": "Use this to answer questions about refunds and returns.", "text": "You can return any item within 30 days of delivery for a full refund."}'
import os, requests
response = requests.post(
"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases",
headers={
"Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}",
"API-Version": "1",
},
json={
"name": "refund_policy",
"instruction": "Use this to answer questions about refunds and returns.",
"text": "You can return any item within 30 days of delivery for a full refund.",
},
)
response.raise_for_status()
data = response.json()["data"]
const response = await fetch("https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.TALKING_AVATAR_API_KEY}`,
"API-Version": "1",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "refund_policy",
"instruction": "Use this to answer questions about refunds and returns.",
"text": "You can return any item within 30 days of delivery for a full refund."
}),
});
const { data } = await response.json();
Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.
POST
/
knowledge-bases
cURL
curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases \ -H "Authorization: Bearer $TALKING_AVATAR_API_KEY" \ -H "API-Version: 1" \ -H "Content-Type: application/json" \ -d '{ "name": "refund_policy", "instruction": "Use this to answer questions about refunds and returns.", "text": "You can return any item within 30 days of delivery for a full refund."}'
import os, requests
response = requests.post(
"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases",
headers={
"Authorization": f"Bearer {os.environ['TALKING_AVATAR_API_KEY']}",
"API-Version": "1",
},
json={
"name": "refund_policy",
"instruction": "Use this to answer questions about refunds and returns.",
"text": "You can return any item within 30 days of delivery for a full refund.",
},
)
response.raise_for_status()
data = response.json()["data"]
const response = await fetch("https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.TALKING_AVATAR_API_KEY}`,
"API-Version": "1",
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "refund_policy",
"instruction": "Use this to answer questions about refunds and returns.",
"text": "You can return any item within 30 days of delivery for a full refund."
}),
});
const { data } = await response.json();
The function name its agents call it by. One per account.
Pattern: ^[A-Za-z0-9_-]{1,64}$
instruction
string
required
When its agents should use it
Required string length: 1 - 1000
text
string
required
What its agents answer from
Required string length: 1 - 50000
fileName
string
The file the text came from, if any (when adding)
Maximum string length: 255
Response
Success
data
object
required
Show child attributes
code
integer
required
message
string
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Talking Avatar","description":"Realistic talking avatars for voice agents, no-code AI voice agents, and a free open-source 3D talking avatar for the browser.","colors":{"primary":"#5B50D6","light":"#8E85F2","dark":"#463CC0"},"logo":{"light":"https://mintcdn.com/talking-avatar-dev/XqO5mCje4YpyAVum/logo/light.png?fit=max\u0026auto=format\u0026n=XqO5mCje4YpyAVum\u0026q=85\u0026s=854bf1c09eeeda085b9cbc8f69233292","dark":"https://mintcdn.com/talking-avatar-dev/XqO5mCje4YpyAVum/logo/dark.png?fit=max\u0026auto=format\u0026n=XqO5mCje4YpyAVum\u0026q=85\u0026s=30fb5eebac1f8074448a1834e6cb7bd5","href":"https://talking-avatar.dev"},"favicon":"https://mintcdn.com/talking-avatar-dev/XqO5mCje4YpyAVum/favicon.svg?fit=max\u0026auto=format\u0026n=XqO5mCje4YpyAVum\u0026q=85\u0026s=371e30ce3bd4e77ac5ec8e1a9dd7fd7c","api":{"playground":{"display":"interactive"},"examples":{"autogenerate":false},"mdx":{"auth":{"method":"bearer"},"server":"https://backend.talking-avatar.dev/api/talking-avatar"}},"background":{"color":{"light":"#FCFCFD","dark":"#0F0E1A"}},"navbar":{"links":[{"href":"https://talking-avatar.dev/demo","label":"Live demo"},{"href":"mailto:support@talking-avatar.dev","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.talking-avatar.dev"}},"footer":{"socials":{"github":"https://github.com/interviewflowai/talking-avatar","website":"https://talking-avatar.dev"}},"seo":{"metatags":{"og:site_name":"Talking Avatar Docs"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://talking-avatar.dev"},{"anchor":"GitHub","icon":"github","href":"https://github.com/interviewflowai/talking-avatar"},{"anchor":"npm","icon":"npm","href":"https://www.npmjs.com/package/@talkingavatar/sdk"},{"anchor":"Slack community","icon":"slack","href":"https://join.slack.com/t/talking-avatar/shared_invite/zt-4e3u9h2ts-JqpSZc~U1ScpKM_IrOq9Ow"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"talking-avatar-dev","hasAudioNarration":false,"actualSubdomain":"talking-avatar-dev","customDomains":["docs.talking-avatar.dev"],"gitSource":{"type":"github","owner":"tushar1357","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":"","_id":"6adf4e40d9bc4ba6afb7e61a"},"entitlements":{},"buildId":"6af700c2e0d078336552b942","clientVersion":"0.0.4143","searchFilterCounts":[{"language":"default","tag":"Guides","count":45},{"language":"default","tag":"API reference","count":26},{"language":"default","tag":"Voice Agents (no code)","count":15},{"language":"default","tag":"Realistic Avatars (API)","count":10},{"language":"default","tag":"Open Source (3D, free)","count":7},{"language":"default","tag":"SDK reference","count":7},{"language":"default","tag":"Your account","count":5},{"language":"default","tag":"Knowledge bases","count":5},{"language":"default","tag":"Voice agents","count":5},{"language":"default","tag":"Realtime avatar API","count":4}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/add-a-knowledge-base","slug":"/api-reference/add-a-knowledge-base","pageMetadata":{"title":"Add a knowledge base","description":"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/add-a-knowledge-base","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add a knowledge base","description":"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/add-a-knowledge-base","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Add a knowledge base","description":"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.","parameters":["892812fc-859f-472a-9041-469fcc95135b"],"requestBody":"102f3b3e-9cd5-49ff-9c5d-32b95e0563e1","responses":{"201":"457f1869-65dc-4b64-aba6-d35afbf7d6e6","4XX":"be5f8623-5c86-4a98-8144-00bb4a66237e","5XX":"c7069ee4-3adb-4393-938b-33275189898f"},"x-codeSamples":[{"lang":"bash","label":"cURL","source":"curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases \\\n -H \"Authorization: Bearer $TALKING_AVATAR_API_KEY\" \\\n -H \"API-Version: 1\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\"\n}'"},{"lang":"python","label":"Python","source":"import os, requests\n\nresponse = requests.post(\n \"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['TALKING_AVATAR_API_KEY']}\",\n \"API-Version\": \"1\",\n },\n json={\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\",\n },\n)\nresponse.raise_for_status()\ndata = response.json()[\"data\"]"},{"lang":"javascript","label":"Node.js","source":"const response = await fetch(\"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases\", {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${process.env.TALKING_AVATAR_API_KEY}`,\n \"API-Version\": \"1\",\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify({\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\"\n }),\n});\nconst { data } = await response.json();"}],"method":"post","type":"path","servers":["6e34b7f5-a74d-42f5-b2f0-acff5f78025a"],"security":["655d29cf-eb65-4b13-93aa-e74718673205"],"path":"/knowledge-bases","baseUrlOptions":["https://backend.talking-avatar.dev/api/talking-avatar"],"title":"Add a knowledge base","codeSamples":[{"label":"cURL","lang":"bash","source":"curl -X POST https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases \\\n -H \"Authorization: Bearer $TALKING_AVATAR_API_KEY\" \\\n -H \"API-Version: 1\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\"\n}'"},{"label":"Python","lang":"python","source":"import os, requests\n\nresponse = requests.post(\n \"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases\",\n headers={\n \"Authorization\": f\"Bearer {os.environ['TALKING_AVATAR_API_KEY']}\",\n \"API-Version\": \"1\",\n },\n json={\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\",\n },\n)\nresponse.raise_for_status()\ndata = response.json()[\"data\"]"},{"label":"Node.js","lang":"javascript","source":"const response = await fetch(\"https://backend.talking-avatar.dev/api/talking-avatar/knowledge-bases\", {\n method: \"POST\",\n headers: {\n Authorization: `Bearer ${process.env.TALKING_AVATAR_API_KEY}`,\n \"API-Version\": \"1\",\n \"Content-Type\": \"application/json\",\n },\n body: JSON.stringify({\n \"name\": \"refund_policy\",\n \"instruction\": \"Use this to answer questions about refunds and returns.\",\n \"text\": \"You can return any item within 30 days of delivery for a full refund.\"\n }),\n});\nconst { data } = await response.json();"}],"requiredOnlyExamples":false,"disableCodeSampleGeneration":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"892812fc-859f-472a-9041-469fcc95135b":{"name":"API-Version","in":"header","description":"The API version. Without it: 1.","schema":{"type":"string","enum":["1"],"description":"The API version. Without it: 1.","uniqueKey":"","typeLabel":"enum\u003cstring>"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","pattern":"^[A-Za-z0-9_-]{1,64}$","not":{"const":"end_call"},"description":"The function name its agents call it by. One per account.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"instruction":{"type":"string","minLength":1,"maxLength":1000,"description":"When its agents should use it","isRequired":true,"uniqueKey":"instruction","typeLabel":"string"},"text":{"type":"string","minLength":1,"maxLength":50000,"description":"What its agents answer from","isRequired":true,"uniqueKey":"text","typeLabel":"string"},"fileName":{"type":"string","maxLength":255,"description":"The file the text came from, if any (when adding)","uniqueKey":"fileName","typeLabel":"string"}},"required":["name","instruction","text"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"example":{"name":"refund_policy","instruction":"Use this to answer questions about refunds and returns.","text":"You can return any item within 30 days of delivery for a full refund."},"examples":{"Example":{"title":"Example","value":{"name":"refund_policy","instruction":"Use this to answer questions about refunds and returns.","text":"You can return any item within 30 days of delivery for a full refund."}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"457f1869-65dc-4b64-aba6-d35afbf7d6e6":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The knowledge base's ID, for an agent's config.knowledgeBaseIds","isRequired":true,"uniqueKey":"data.id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","description":"The function name its agents call it by","isRequired":true,"uniqueKey":"data.name","typeLabel":"string"},"instruction":{"type":"string","description":"When its agents use it","isRequired":true,"uniqueKey":"data.instruction","typeLabel":"string"},"file_name":{"oneOf":[{"type":"string","description":"The file its text came from","isRequired":true,"uniqueKey":"data.file_name.oneOf.0","typeLabel":"string"},{"type":"null","description":"The file its text came from","isRequired":true,"uniqueKey":"data.file_name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"data.file_name","typeLabel":"string | null"},"characters":{"type":"integer","description":"How long its text is","isRequired":true,"uniqueKey":"data.characters","typeLabel":"integer"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"data.updated_at","typeLabel":"string\u003cdate-time>"},"agents":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"The agent's ID","isRequired":true,"uniqueKey":"data.agents.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","isRequired":true,"uniqueKey":"data.agents.items.[INDEX].name","typeLabel":"string"}},"required":["id","name"],"additionalProperties":false,"uniqueKey":"data.agents.items.[INDEX]","typeLabel":"object"},"description":"The agents it's attached to","isRequired":true,"uniqueKey":"data.agents","typeLabel":"object[]"}},"required":["id","name","instruction","file_name","characters","created_at","updated_at","agents"],"additionalProperties":false,"isRequired":true,"uniqueKey":"data","typeLabel":"object"},"code":{"type":"integer","const":201,"isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"required":["data","code"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","instruction":"\u003cstring>","file_name":"\u003cstring>","characters":123,"created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z","agents":[{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>"}]},"code":201,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"be5f8623-5c86-4a98-8144-00bb4a66237e":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"The HTTP status","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong, readable","uniqueKey":"message","typeLabel":"string"},"data":{"type":"null","uniqueKey":"data","typeLabel":"null"}},"required":["code"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","data":null}}},"exampleType":"generated"}},"exampleType":"generated"},"c7069ee4-3adb-4393-938b-33275189898f":{"description":"Error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"The HTTP status","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"message":{"type":"string","description":"What went wrong, readable","uniqueKey":"message","typeLabel":"string"},"data":{"type":"null","uniqueKey":"data","typeLabel":"null"}},"required":["code"],"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>","data":null}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"655d29cf-eb65-4b13-93aa-e74718673205":{"apiKey":{"type":"http","scheme":"bearer","description":"Your API key, tav_…","x-default":"YOUR_API_KEY","scopes":[],"schemeName":"apiKey"}}},"servers":{"6e34b7f5-a74d-42f5-b2f0-acff5f78025a":{"url":"https://backend.talking-avatar.dev/api/talking-avatar"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key, tav_…","x-default":"YOUR_API_KEY","scopes":[],"schemeName":"apiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key, tav_…","format":"bearer","default":"YOUR_API_KEY","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"apiKey","name":"Authorization"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"talking-avatar-dev","siteName":"Talking Avatar","title":"Add a knowledge base - Talking Avatar","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-13T08:45:54.796Z","originalFileLocation":"api-reference/add-a-knowledge-base.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Talking Avatar\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add a knowledge base - Talking Avatar\">\u003cmeta data-mint-head property=\"og:description\" content=\"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Talking Avatar Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://talking-avatar-dev.mintlify.site/_mintlify/api/og/v2?division=Knowledge+bases\u0026amp;title=Add+a+knowledge+base\u0026amp;description=Attach+it+to+agents+by+its+id%2C+in+their+config.knowledgeBaseIds.+409+if+the+name+is+taken.\u0026amp;theme=19f6956ab966387e8922eba2\u0026amp;signature=34e984eaa5266e3850f44bb7b7f70658339a62257a1df8cdaa81bb6492652571\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add a knowledge base - Talking Avatar\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://talking-avatar-dev.mintlify.site/_mintlify/api/og/v2?division=Knowledge+bases\u0026amp;title=Add+a+knowledge+base\u0026amp;description=Attach+it+to+agents+by+its+id%2C+in+their+config.knowledgeBaseIds.+409+if+the+name+is+taken.\u0026amp;theme=19f6956ab966387e8922eba2\u0026amp;signature=34e984eaa5266e3850f44bb7b7f70658339a62257a1df8cdaa81bb6492652571\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/talking-avatar-dev/zAkMraVcQjMTumKa/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Talking Avatar\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#5B50D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/add-a-knowledge-base.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.talking-avatar.dev/#organization\",\"name\":\"Talking Avatar\",\"url\":\"https://docs.talking-avatar.dev\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/talking-avatar-dev/XqO5mCje4YpyAVum/logo/light.png?fit=max\u0026auto=format\u0026n=XqO5mCje4YpyAVum\u0026q=85\u0026s=854bf1c09eeeda085b9cbc8f69233292\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.talking-avatar.dev#website\",\"name\":\"Talking Avatar\",\"url\":\"https://docs.talking-avatar.dev\",\"publisher\":{\"@id\":\"https://docs.talking-avatar.dev/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base#webpage\",\"url\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base\",\"name\":\"Add a knowledge base\",\"description\":\"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\",\"dateModified\":\"2026-11-13T08:45:54.796Z\",\"isPartOf\":{\"@id\":\"https://docs.talking-avatar.dev#website\"},\"breadcrumb\":{\"@id\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Knowledge bases\",\"item\":\"https://docs.talking-avatar.dev/api-reference/list-knowledge-bases\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Add a knowledge base\",\"item\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base#apireference\",\"headline\":\"Add a knowledge base\",\"name\":\"Add a knowledge base\",\"description\":\"Attach it to agents by its id, in their config.knowledgeBaseIds. 409 if the name is taken.\",\"url\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base\",\"mainEntityOfPage\":{\"@id\":\"https://docs.talking-avatar.dev/api-reference/add-a-knowledge-base#webpage\"},\"dateModified\":\"2026-11-13T08:45:54.796Z\",\"publisher\":{\"@id\":\"https://docs.talking-avatar.dev/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.talking-avatar.dev#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Talking Avatar\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Talking Avatar\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/add-a-knowledge-base.md","siteName":"Talking Avatar","nav":{"global":{"anchors":[{"anchor":"Website","icon":"globe","href":"https://talking-avatar.dev"},{"anchor":"GitHub","icon":"github","href":"https://github.com/interviewflowai/talking-avatar"},{"anchor":"npm","icon":"npm","href":"https://www.npmjs.com/package/@talkingavatar/sdk"},{"anchor":"Slack community","icon":"slack","href":"https://join.slack.com/t/talking-avatar/shared_invite/zt-4e3u9h2ts-JqpSZc~U1ScpKM_IrOq9Ow"}]},"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"SDK reference","pages":[{"title":"SDK reference","href":"/sdk/installation"}]},{"tab":"API reference","groups":[{"group":"Overview","pages":[{"title":"API overview","icon":"code","href":"/api-reference/introduction"}]},{"group":"Realtime avatar API","pages":[{"title":"Realtime avatar API","icon":"plug","href":"/api-reference/realtime/overview"},{"title":"Messages","icon":"list","href":"/api-reference/realtime/messages"},{"title":"Browser playback","icon":"display","href":"/api-reference/realtime/browser-playback"},{"title":"Python example","icon":"python","href":"/api-reference/realtime/python"}]},{"group":"Account","pages":[{"title":"Get the account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /account","href":"/api-reference/get-the-account"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage","href":"/api-reference/list-sessions"},{"title":"List balance changes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /credit-logs","href":"/api-reference/list-balance-changes"}]},{"group":"Voice agents","pages":[{"title":"List voice agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents","href":"/api-reference/list-voice-agents"},{"title":"Create a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-agents","href":"/api-reference/create-a-voice-agent"},{"title":"Get a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents/{id}","href":"/api-reference/get-a-voice-agent"},{"title":"Update a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /voice-agents/{id}","href":"/api-reference/update-a-voice-agent"},{"title":"Delete a voice agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice-agents/{id}","href":"/api-reference/delete-a-voice-agent"}]},{"group":"Calls","pages":[{"title":"List calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents/calls","href":"/api-reference/list-calls"},{"title":"Get a call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-agents/calls/{callId}","href":"/api-reference/get-a-call"}]},{"group":"Private agent links","pages":[{"title":"Create a link","api":"POST https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/{agentId}/links","href":"/api-reference/agent-links/create"},{"title":"List links","api":"GET https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/{agentId}/links","href":"/api-reference/agent-links/list"},{"title":"Delete a link","api":"DELETE https://backend.talking-avatar.dev/api/talking-avatar/voice-agents/{agentId}/links/{linkId}","href":"/api-reference/agent-links/delete"}]},{"group":"Knowledge bases","pages":[{"title":"List knowledge bases","description":"Your knowledge bases, newest first, without their text.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge-bases","href":"/api-reference/list-knowledge-bases"},{"title":"Add a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /knowledge-bases","href":"/api-reference/add-a-knowledge-base"},{"title":"Get a knowledge base","description":"One knowledge base, with its text.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge-bases/{id}","href":"/api-reference/get-a-knowledge-base"},{"title":"Update a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /knowledge-bases/{id}","href":"/api-reference/update-a-knowledge-base"},{"title":"Delete a knowledge base","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /knowledge-bases/{id}","href":"/api-reference/delete-a-knowledge-base"}]},{"group":"Requests we send you","pages":[{"title":"Tool call","icon":"wrench","href":"/api-reference/tool-call-request"},{"title":"Post-call webhook","icon":"webhook","href":"/api-reference/call-ended-event"},{"title":"Verify signatures","icon":"signature","href":"/api-reference/verify-signatures"}]}]}]},"basePath":"","title":"Add a knowledge base - Talking Avatar","buildId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","deploymentId":"dpl_Fyv1NbzwP68g2bEH2Roy98uY1zmE","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DdEMm2kG.js","utils-BMo572L7.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C-4m9KAx.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DPLK2Oq9.js","snippetPresets-BKjfJMC9.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DTsgtCEj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C8vmhyQM.js","shallow-r9w8LQGS.js","getApiPlaygroundDisplay-DjPI64HQ.js","CodeSnippet-C8Bvhl16.js","CodeSnippets-BtWUwcMy.js","Page-BIYvYBgk.js","getPastedJson-Dcm_3Pgl.js","icon-BXwrTpjc.js","MethodPill-CcjfVmmy.js","DuplicateIcon-BuKIbXAQ.js","createIcon-DaL9yXsO.js","DynamicMarkdown-Co5nikxh.js","SectionHeading-P4UNTsMZ.js","axios-vUo_bRtp.js","Markdown-CEfymfIH.js","clsx-Dq9TQuNi.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-D2J8knkn.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BgZ2ThuU.js"]}