{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}
Agents
Update agent
Partially updates an agent. Only provided fields are changed.
{
"error": {
"code": "SERVICE_UNDER_MAINTENANCE",
"message": "The API is temporarily unavailable for scheduled maintenance, please try again later"
}
}
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Chatbase","colors":{"primary":"#18181b","light":"#f4f4f5","dark":"#18181b"},"logo":{"light":"https://mintcdn.com/chatbase/pJU9vM3D9oN_YQME/logo/light.svg?fit=max\u0026auto=format\u0026n=pJU9vM3D9oN_YQME\u0026q=85\u0026s=a45a73af7ac778cd0920dbb6ad1aaa93","dark":"https://mintcdn.com/chatbase/8k6_6eFSz4sj8EO0/logo/dark.svg?fit=max\u0026auto=format\u0026n=8k6_6eFSz4sj8EO0\u0026q=85\u0026s=c0c106d2f92f6a87f872a2be66706041","href":"https://chatbase.co"},"favicon":"https://mintcdn.com/chatbase/NsUPSmNqecm03uiz/favicon.ico?fit=max\u0026auto=format\u0026n=NsUPSmNqecm03uiz\u0026q=85\u0026s=b37388fc54cd76cfaf3efcb8ab4a4dc8","appearance":{},"navbar":{"links":[{"href":"https://chatbase.co/help","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://www.chatbase.co/dashboard"}},"footer":{"socials":{"x":"https://x.com/chatbase_co","linkedin":"https://linkedin.com/company/chatbase-co","youtube":"https://www.youtube.com/@chatbase_"}},"seo":{"metatags":{"canonical":"https://www.chatbase.co/docs"}},"contextual":{"options":["copy","view","chatgpt","claude"],"display":"header"},"metadata":{"timestamp":false},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"chatbase","hasAudioNarration":false,"actualSubdomain":"chatbase","customDomains":["chatbase.co"],"gitSource":{"type":"github","owner":"chatbase-co","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adfc6a09b9230fa127ba040","collectionId":"f944d6dc-a02c-46cc-90d5-49ac75d4e0ce","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adfc6a09b9230fa127ba040"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae07392cdcf99f97c30c970","clientVersion":"0.0.3971","searchFilterCounts":[{"language":"default","tag":"User Guide","count":100},{"language":"default","tag":"API Reference","count":76},{"language":"default","tag":"Endpoints","count":62},{"language":"default","tag":"API v2","count":55},{"language":"default","tag":"Integrations","count":34},{"language":"default","tag":"Developer Guide","count":30},{"language":"default","tag":"AI Agent Management","count":30},{"language":"default","tag":"SDKs","count":26},{"language":"default","tag":"Help Desk","count":22},{"language":"default","tag":"API v1","count":21}]},"assistantConfig":{},"basePath":"/docs","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-dropdown-trigger{border-color:transparent!important;border-bottom-color:rgb(var(--gray-500)/.2)!important;border-radius:0!important;padding:.5rem .875rem .875rem 1rem!important}.nav-dropdown-trigger .nav-dropdown-item-icon{display:none!important}.nav-dropdown-trigger .nav-dropdown-item-text-container{padding-left:0!important}.nav-dropdown-trigger .nav-dropdown-item-title{font-weight:600!important}.nav-dropdown-item-title::after{display:inline-block;margin-left:.5rem;padding:.125rem .5rem;border-radius:.375rem;font-size:.7rem;font-weight:600;line-height:1.2;vertical-align:middle}:is(.nav-dropdown-trigger, .nav-dropdown-item):has([style*=\"/code.svg\"]) .nav-dropdown-item-title::after{content:\"Current\";color:rgb(22 163 74);background:rgb(22 163 74/.12)}:is(.nav-dropdown-trigger, .nav-dropdown-item):has([style*=\"/box-archive.svg\"]) .nav-dropdown-item-title::after{content:\"Deprecated\";color:rgb(217 119 6);background:rgb(217 119 6/.12)}"}],"page":{"pagePath":"api-reference/v2/agents/update-agent","slug":"/api-reference/v2/agents/update-agent","pageMetadata":{"title":"Update agent","description":"Partially updates an agent. Only provided fields are changed.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}","href":"/api-reference/v2/agents/update-agent","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: \"Partially updates an agent. Only provided fields are changed.\"\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":"Update agent","description":"Partially updates an agent. Only provided fields are changed.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}","href":"/api-reference/v2/agents/update-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"updateAgent","x-mcp":{"tool":"chatbase_update_agent","scopes":["agents:write"],"annotations":{"idempotent":true}},"tags":["Agents"],"summary":"Update agent","description":"Partially updates an agent. Only provided fields are changed.","security":["1600f3c9-0ed0-481a-b1bd-b2580df08e91"],"parameters":["ba1fd7ad-971e-4031-9696-9200998cdc43"],"requestBody":"4cda64d8-8e42-4a11-9ea0-7a16b68a3fbc","responses":{"200":"532db088-5f68-4282-87d8-31dd064cd180","400":"2dec7c9d-4f45-462f-a897-e04959301918","401":"9fb0ac68-ccff-463f-a6b9-0ba5874ec358","403":"ce0b7e7f-759a-49f4-a4b0-5399df6e2342","404":"ed47f6ec-a13f-44e2-89ec-9455e35fc76e","429":"2ffdd310-2880-48cb-974c-54bcabdd7d17","500":"d474ad5c-d1c3-4ea5-91cf-227d582ac8b5","503":"69baa81e-3b7d-4eb2-b474-fb798076d211"},"method":"put","type":"path","servers":["131cbcde-68c0-4c82-baf4-8793c7424f12"],"path":"/agents/{agentId}","baseUrlOptions":["https://www.chatbase.co/api/v2"],"title":"Update agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"ba1fd7ad-971e-4031-9696-9200998cdc43":{"schema":{"type":"string","minLength":1,"description":"The agent ID","example":"5QHA6VB-DIAbBhxwqxfdi","isRequired":true,"uniqueKey":"","typeLabel":"string"},"required":true,"description":"The agent ID","name":"agentId","in":"path"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":100,"description":"Agent name","uniqueKey":"name","typeLabel":"string"},"instructions":{"type":"string","maxLength":30000,"description":"System prompt (max 30,000 characters)","uniqueKey":"instructions","typeLabel":"string"},"channelInstructions":{"oneOf":[{"type":"object","properties":{"chat_widget":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.chat_widget.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.chat_widget.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.chat_widget.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.chat_widget.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.chat_widget","typeLabel":"string | object"},"help_page":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.help_page.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.help_page.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.help_page.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.help_page.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.help_page","typeLabel":"string | object"},"center_stage":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.center_stage.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.center_stage.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.center_stage.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.center_stage.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.center_stage","typeLabel":"string | object"},"side_panel":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.side_panel.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.side_panel.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.side_panel.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.side_panel.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.side_panel","typeLabel":"string | object"},"slack":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.slack.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.slack.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.slack.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.slack.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.slack","typeLabel":"string | object"},"whatsapp":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.whatsapp.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.whatsapp.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.whatsapp.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.whatsapp.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.whatsapp","typeLabel":"string | object"},"messenger":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.messenger.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.messenger.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.messenger.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.messenger.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.messenger","typeLabel":"string | object"},"instagram":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.instagram.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.instagram.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.instagram.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.instagram.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.instagram","typeLabel":"string | object"},"salesforce":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.salesforce.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.salesforce.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.salesforce.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.salesforce.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.salesforce","typeLabel":"string | object"},"zendesk":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.zendesk.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.zendesk","typeLabel":"string | object"},"zendesk_messaging":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk_messaging.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk_messaging.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.zendesk_messaging.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.zendesk_messaging.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.zendesk_messaging","typeLabel":"string | object"},"api":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.api.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.api.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.api.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.api.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.api","typeLabel":"string | object"},"email":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.email.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.email.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.email.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.email.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.email","typeLabel":"string | object"},"android_sdk":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.android_sdk.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.android_sdk.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.android_sdk.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.android_sdk.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.android_sdk","typeLabel":"string | object"},"ios_sdk":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.ios_sdk.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.ios_sdk.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.ios_sdk.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.ios_sdk.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.ios_sdk","typeLabel":"string | object"},"phone":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.phone.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.phone.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.phone.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.phone.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.phone","typeLabel":"string | object"},"search":{"oneOf":[{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.search.oneOf.0","typeLabel":"string"},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.search.oneOf.1.chat","typeLabel":"string"},"voice":{"type":"string","maxLength":30000,"uniqueKey":"channelInstructions.oneOf.0.search.oneOf.1.voice","typeLabel":"string"}},"uniqueKey":"channelInstructions.oneOf.0.search.oneOf.1","typeLabel":"object"}],"uniqueKey":"channelInstructions.oneOf.0.search","typeLabel":"string | object"}},"description":"Per-channel instruction overrides (max 30,000 characters each)","uniqueKey":"channelInstructions.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"chat_widget":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"help_page":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"center_stage":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"side_panel":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"slack":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"whatsapp":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"messenger":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"instagram":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"salesforce":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"zendesk":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"zendesk_messaging":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"api":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"email":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"android_sdk":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"ios_sdk":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"phone":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]},"search":{"oneOf":[{"type":"string","maxLength":30000},{"type":"object","properties":{"chat":{"type":"string","maxLength":30000},"voice":{"type":"string","maxLength":30000}}}]}},"description":"Per-channel instruction overrides (max 30,000 characters each)","uniqueKey":"channelInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"channelInstructions","typeLabel":"object | null"},"model":{"type":"string","enum":["gpt-oss-120b","gpt-oss-20b","gpt-5.2","gpt-5.5","gpt-5.6-terra","gpt-6.1-sol","gpt-6.1-terra","gpt-6-luna","claude-opus-5-5","claude-sonnet-5-5","claude-haiku-5-5","gemini-2.5-pro","gemini-3-flash","gemini-3.1-flash-lite","gemini-3.1-pro","gemini-3.5-flash-lite","gemini-3.6-flash","gemini-3.8-flash","grok-4.7","DeepSeek-V3.1","DeepSeek-R1","DeepSeek-V4-Flash","DeepSeek-V4.1-Flash","kimi-k2.6","mistral-medium-3.5","mistral-small-2603","glm-5.2","glm-5.3-flash","auto"],"description":"AI model","example":"gpt-5.6-terra","uniqueKey":"model","typeLabel":"enum\u003cstring>"},"temp":{"type":"number","minimum":0,"maximum":1,"description":"Temperature (0–1)","uniqueKey":"temp","typeLabel":"number"},"visibility":{"type":"string","enum":["public","private"],"description":"Visibility","uniqueKey":"visibility","typeLabel":"enum\u003cstring>"},"allowedDomains":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"allowedDomains.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Allowed embed domains","uniqueKey":"allowedDomains.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Allowed embed domains","uniqueKey":"allowedDomains.oneOf.1","typeLabel":"null"}],"uniqueKey":"allowedDomains","typeLabel":"string[] | null"},"suggestedMessages":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","required":["text","type","order"],"properties":{"text":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.text","typeLabel":"string"},"type":{"type":"string","enum":["single"],"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"order":{"type":"number","isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.order","typeLabel":"number"},"icon":{"oneOf":[{"type":"string","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.icon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0.icon","typeLabel":"string | null"}},"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["name","type","order","items"],"properties":{"name":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.name","typeLabel":"string"},"type":{"type":"string","enum":["nested"],"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"order":{"type":"number","isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.order","typeLabel":"number"},"items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","minLength":1,"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].text","typeLabel":"string"},"order":{"type":"number","isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].order","typeLabel":"number"},"icon":{"oneOf":[{"type":"string","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].icon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX].icon","typeLabel":"string | null"}},"required":["text","order"],"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items.items.[INDEX]","typeLabel":"object"},"minItems":1,"maxItems":20,"isRequired":true,"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.\\items","typeLabel":"object[]"},"icon":{"oneOf":[{"type":"string","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.icon.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.icon.oneOf.1","typeLabel":"null"}],"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1.icon","typeLabel":"string | null"}},"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"suggestedMessages.oneOf.0.items.[INDEX]","typeLabel":"object"},"description":"Suggested messages","uniqueKey":"suggestedMessages.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"oneOf":[{"type":"object","required":["text","type","order"],"properties":{"text":{"type":"string","minLength":1},"type":{"type":"string","enum":["single"]},"order":{"type":"number"},"icon":{"oneOf":[{"type":"string"},{"type":"null"}]}}},{"type":"object","required":["name","type","order","items"],"properties":{"name":{"type":"string","minLength":1},"type":{"type":"string","enum":["nested"]},"order":{"type":"number"},"icon":{"oneOf":[{"type":"string"},{"type":"null"}]},"items":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string","minLength":1},"order":{"type":"number"},"icon":{"oneOf":[{"type":"string"},{"type":"null"}]}},"required":["text","order"]},"minItems":1,"maxItems":20}}}]},"description":"Suggested messages","uniqueKey":"suggestedMessages.oneOf.1","typeLabel":"null"}],"uniqueKey":"suggestedMessages","typeLabel":"object[] | null"},"initialMessages":{"type":"array","items":{"type":"string","uniqueKey":"initialMessages.items.[INDEX]","typeLabel":"string"},"description":"Initial messages","uniqueKey":"initialMessages","typeLabel":"string[]"},"creditLimit":{"oneOf":[{"type":"integer","description":"Per-agent credit limit (null = no limit)","uniqueKey":"creditLimit.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Per-agent credit limit (null = no limit)","uniqueKey":"creditLimit.oneOf.1","typeLabel":"null"}],"uniqueKey":"creditLimit","typeLabel":"integer | null"},"notificationsSettings":{"oneOf":[{"type":"object","properties":{"dailyLeadsCollected":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether this notification type is enabled","isRequired":true,"uniqueKey":"notificationsSettings.oneOf.0.dailyLeadsCollected.active","typeLabel":"boolean"},"emails":{"type":"array","items":{"type":"string","pattern":"^\\w+([+.-]?\\w+)*@\\w+([.-]?\\w+)*(\\.\\w{2,})+$","example":"alerts@company.com","uniqueKey":"notificationsSettings.oneOf.0.dailyLeadsCollected.emails.items.[INDEX]","typeLabel":"string"},"maxItems":10,"description":"Recipient email addresses (max 10)","isRequired":true,"uniqueKey":"notificationsSettings.oneOf.0.dailyLeadsCollected.emails","typeLabel":"string[]"}},"required":["active","emails"],"description":"Daily summary of new leads collected by this agent","uniqueKey":"notificationsSettings.oneOf.0.dailyLeadsCollected","typeLabel":"object"},"dailyConversations":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether this notification type is enabled","isRequired":true,"uniqueKey":"notificationsSettings.oneOf.0.dailyConversations.active","typeLabel":"boolean"},"emails":{"type":"array","items":{"type":"string","pattern":"^\\w+([+.-]?\\w+)*@\\w+([.-]?\\w+)*(\\.\\w{2,})+$","example":"alerts@company.com","uniqueKey":"notificationsSettings.oneOf.0.dailyConversations.emails.items.[INDEX]","typeLabel":"string"},"maxItems":10,"description":"Recipient email addresses (max 10)","isRequired":true,"uniqueKey":"notificationsSettings.oneOf.0.dailyConversations.emails","typeLabel":"string[]"}},"required":["active","emails"],"description":"Daily summary of conversation volume for this agent","uniqueKey":"notificationsSettings.oneOf.0.dailyConversations","typeLabel":"object"}},"description":"Email notification settings (null = disable all notifications)","uniqueKey":"notificationsSettings.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"dailyLeadsCollected":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether this notification type is enabled"},"emails":{"type":"array","items":{"type":"string","pattern":"^\\w+([+.-]?\\w+)*@\\w+([.-]?\\w+)*(\\.\\w{2,})+$","example":"alerts@company.com"},"maxItems":10,"description":"Recipient email addresses (max 10)"}},"required":["active","emails"],"description":"Daily summary of new leads collected by this agent"},"dailyConversations":{"type":"object","properties":{"active":{"type":"boolean","description":"Whether this notification type is enabled"},"emails":{"type":"array","items":{"type":"string","pattern":"^\\w+([+.-]?\\w+)*@\\w+([.-]?\\w+)*(\\.\\w{2,})+$","example":"alerts@company.com"},"maxItems":10,"description":"Recipient email addresses (max 10)"}},"required":["active","emails"],"description":"Daily summary of conversation volume for this agent"}},"description":"Email notification settings (null = disable all notifications)","uniqueKey":"notificationsSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"notificationsSettings","typeLabel":"object | null"},"ipRateLimits":{"oneOf":[{"type":"object","properties":{"limit":{"type":"integer","minimum":1,"maximum":200,"description":"Maximum messages per timeframe (1–200)","example":20,"uniqueKey":"ipRateLimits.oneOf.0.limit","typeLabel":"integer"},"timeframe":{"type":"integer","minimum":1,"maximum":3600,"description":"Timeframe in seconds for the rate limit (1–3600)","example":240,"uniqueKey":"ipRateLimits.oneOf.0.timeframe","typeLabel":"integer"},"message":{"type":"string","description":"Message shown when rate limit is exceeded","example":"Too many messages in a row","uniqueKey":"ipRateLimits.oneOf.0.message","typeLabel":"string"}},"description":"IP-based rate limit settings (partial update; null = reset to defaults)","uniqueKey":"ipRateLimits.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"limit":{"type":"integer","minimum":1,"maximum":200,"description":"Maximum messages per timeframe (1–200)","example":20},"timeframe":{"type":"integer","minimum":1,"maximum":3600,"description":"Timeframe in seconds for the rate limit (1–3600)","example":240},"message":{"type":"string","description":"Message shown when rate limit is exceeded","example":"Too many messages in a row"}},"description":"IP-based rate limit settings (partial update; null = reset to defaults)","uniqueKey":"ipRateLimits.oneOf.1","typeLabel":"null"}],"uniqueKey":"ipRateLimits","typeLabel":"object | null"},"spamSettings":{"oneOf":[{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether spam detection is enabled","isRequired":true,"uniqueKey":"spamSettings.oneOf.0.enabled","typeLabel":"boolean"},"prompt":{"type":"string","maxLength":2000,"description":"Custom prompt describing what counts as spam for this agent (max 2000 chars)","isRequired":true,"uniqueKey":"spamSettings.oneOf.0.prompt","typeLabel":"string"}},"required":["enabled","prompt"],"description":"Spam detection settings (null = disable spam detection)","uniqueKey":"spamSettings.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"enabled":{"type":"boolean","description":"Whether spam detection is enabled"},"prompt":{"type":"string","maxLength":2000,"description":"Custom prompt describing what counts as spam for this agent (max 2000 chars)"}},"required":["enabled","prompt"],"description":"Spam detection settings (null = disable spam detection)","uniqueKey":"spamSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"spamSettings","typeLabel":"object | null"},"voiceSettings":{"oneOf":[{"type":"object","properties":{"voice":{"type":"object","properties":{"voiceName":{"type":"string","enum":["Sarah","Laura","Alice","Matilda","Jessica","Lily","Bella","Roger","George","Charlie","Adam","Daniel","Brian","Eric","Chris","Liam","Harry","Will","Bill","Callum","Masry","Hanafi","Alberto Rodríguez","Jhenny","Anna","Peter","Marc Aurèle","Marie Line","Yasmin Alves","Lax","Skylar","Corey","Jacqueline","Blake","Pedro","Marta","Alloy","Ash","Ballad","Coral","Echo","Fable","Nova","Onyx","Sage","Shimmer","Nouran","Nermin","Othman","Layla","Nada","Mariam","Samir","Eman","Haneen","Fahd","Jasem","Marwa","Razan","Yehya","Hamdan","Zephyr","Puck","Charon","Kore","Fenrir","Leda","Orus","Aoede","Enceladus","Sulafat","Mina","Nina","Ruby","Mason","Rohan"],"example":"Corey","description":"Name of the voice for this agent.","isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.voice.voiceName","typeLabel":"enum\u003cstring>"},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speech rate multiplier (0.7–1.2). Only supported on select voices; ignored for others.","example":1,"uniqueKey":"voiceSettings.oneOf.0.voice.speed","typeLabel":"number"},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Voice consistency (0–1). Higher values produce more consistent delivery. Only supported on select voices; ignored for others.","example":0.5,"uniqueKey":"voiceSettings.oneOf.0.voice.stability","typeLabel":"number"},"similarity":{"type":"number","minimum":0,"maximum":1,"description":"How closely the output matches the reference voice sample (0–1). Only supported on select voices; ignored for others.","example":0.75,"uniqueKey":"voiceSettings.oneOf.0.voice.similarity","typeLabel":"number"},"instructions":{"type":"string","maxLength":500,"description":"Natural-language delivery instructions for the voice (max 500 chars). Only supported on select voices; ignored for others.","example":"Speak slowly and clearly.","uniqueKey":"voiceSettings.oneOf.0.voice.instructions","typeLabel":"string"}},"required":["voiceName"],"description":"Text-to-speech voice configuration","uniqueKey":"voiceSettings.oneOf.0.voice","typeLabel":"object"},"transcriber":{"type":"object","properties":{"model":{"type":"string","enum":["elevenlabs/scribe_v2_realtime","cartesia/ink-2","cartesia/ink-whisper","deepgram/nova-3","deepgram/nova-2","deepgram/flux-general-multi","soniox/stt-rt-v5","soniox/stt-rt-v4","google/gemini-3.5-transcribe-live","hamsa/hamsa-ar"],"example":"soniox/stt-rt-v5","description":"Speech-to-text model to use for this agent.","isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.transcriber.model","typeLabel":"enum\u003cstring>"},"language":{"type":"string","description":"BCP-47 language code for speech recognition (e.g. \"en\", \"fr\", \"ar\"). Use \"multi\" for automatic detection. Valid codes depend on the selected model.","example":"multi","isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.transcriber.language","typeLabel":"string"},"minSilenceDuration":{"type":"number","minimum":0.1,"maximum":3,"description":"Seconds of continuous silence that signals the user has finished speaking (0.1–3.0). Lower values make the agent respond faster but may cut off slow speakers.","example":0.75,"isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.transcriber.minSilenceDuration","typeLabel":"number"},"activationThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Voice activity detection sensitivity (0–1). Lower values detect quieter speech but may pick up background noise. Higher values require clearer speech to activate.","example":0.5,"isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.transcriber.activationThreshold","typeLabel":"number"}},"required":["model","language","minSilenceDuration","activationThreshold"],"description":"Speech-to-text (voice input) configuration","uniqueKey":"voiceSettings.oneOf.0.transcriber","typeLabel":"object"},"recordings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voice calls are recorded and stored","isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.recordings.enabled","typeLabel":"boolean"},"retentionDays":{"type":"integer","minimum":0,"description":"How many days recordings are kept before automatic deletion. 0 disables storage even when enabled is true.","example":30,"isRequired":true,"uniqueKey":"voiceSettings.oneOf.0.recordings.retentionDays","typeLabel":"integer"}},"required":["enabled","retentionDays"],"description":"Call recording and retention settings","uniqueKey":"voiceSettings.oneOf.0.recordings","typeLabel":"object"},"maxConcurrentSessions":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum simultaneous active voice calls for this agent. null = no limit.","example":5,"uniqueKey":"voiceSettings.oneOf.0.maxConcurrentSessions.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"description":"Maximum simultaneous active voice calls for this agent. null = no limit.","example":5,"uniqueKey":"voiceSettings.oneOf.0.maxConcurrentSessions.oneOf.1","typeLabel":"null"}],"uniqueKey":"voiceSettings.oneOf.0.maxConcurrentSessions","typeLabel":"integer | null"},"maxCallDurationSeconds":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum length of a single call in seconds. The call ends automatically when reached. null = no limit.","example":900,"uniqueKey":"voiceSettings.oneOf.0.maxCallDurationSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"description":"Maximum length of a single call in seconds. The call ends automatically when reached. null = no limit.","example":900,"uniqueKey":"voiceSettings.oneOf.0.maxCallDurationSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voiceSettings.oneOf.0.maxCallDurationSeconds","typeLabel":"integer | null"},"maxDailyCallsPerUser":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum voice calls a single user can start per calendar day. null = no limit.","example":10,"uniqueKey":"voiceSettings.oneOf.0.maxDailyCallsPerUser.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"description":"Maximum voice calls a single user can start per calendar day. null = no limit.","example":10,"uniqueKey":"voiceSettings.oneOf.0.maxDailyCallsPerUser.oneOf.1","typeLabel":"null"}],"uniqueKey":"voiceSettings.oneOf.0.maxDailyCallsPerUser","typeLabel":"integer | null"},"model":{"type":"string","enum":["gpt-oss-120b","gpt-oss-20b","gpt-5.2","gpt-5.5","gpt-5.6-terra","gpt-6.1-sol","gpt-6.1-terra","gpt-6-luna","claude-opus-5-5","claude-sonnet-5-5","claude-haiku-5-5","gemini-2.5-pro","gemini-3-flash","gemini-3.1-flash-lite","gemini-3.1-pro","gemini-3.5-flash-lite","gemini-3.6-flash","gemini-3.8-flash","grok-4.7","DeepSeek-V3.1","DeepSeek-R1","DeepSeek-V4-Flash","DeepSeek-V4.1-Flash","kimi-k2.6","mistral-medium-3.5","mistral-small-2603","glm-5.2","glm-5.3-flash","auto"],"description":"AI model used to generate responses during a voice call. Can be set independently from the chat model — faster, cheaper models are common here.","example":"gpt-6-luna","uniqueKey":"voiceSettings.oneOf.0.model","typeLabel":"enum\u003cstring>"},"temperature":{"type":"number","minimum":0,"maximum":1,"description":"Randomness of voice responses (0–1). 0 = deterministic and focused, 1 = more varied and creative.","example":0,"uniqueKey":"voiceSettings.oneOf.0.temperature","typeLabel":"number"},"allowInterruptions":{"type":"boolean","description":"When true the user can speak while the agent is talking and the agent will stop and listen. When false the agent finishes its turn before processing new speech.","uniqueKey":"voiceSettings.oneOf.0.allowInterruptions","typeLabel":"boolean"},"allowTextInput":{"type":"boolean","description":"When true users can also type messages during a voice session instead of only speaking.","uniqueKey":"voiceSettings.oneOf.0.allowTextInput","typeLabel":"boolean"},"endConversationAfterSilenceSeconds":{"oneOf":[{"type":"integer","minimum":10,"description":"Seconds of inactivity before the session ends automatically. Minimum 10 seconds. null = session never auto-ends.","example":300,"uniqueKey":"voiceSettings.oneOf.0.endConversationAfterSilenceSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":10,"description":"Seconds of inactivity before the session ends automatically. Minimum 10 seconds. null = session never auto-ends.","example":300,"uniqueKey":"voiceSettings.oneOf.0.endConversationAfterSilenceSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voiceSettings.oneOf.0.endConversationAfterSilenceSeconds","typeLabel":"integer | null"},"initialMessage":{"type":"string","maxLength":500,"description":"Message the agent speaks immediately when a voice session starts, before the user says anything. Leave empty to wait for the user to speak first (max 500 chars).","uniqueKey":"voiceSettings.oneOf.0.initialMessage","typeLabel":"string"},"errorMessage":{"type":"string","maxLength":500,"description":"Fallback message spoken to the user when the agent encounters an unrecoverable error during a call (max 500 chars).","uniqueKey":"voiceSettings.oneOf.0.errorMessage","typeLabel":"string"}},"description":"Voice mode configuration (null = disable voice mode)","uniqueKey":"voiceSettings.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"voice":{"type":"object","properties":{"voiceName":{"type":"string","enum":["Sarah","Laura","Alice","Matilda","Jessica","Lily","Bella","Roger","George","Charlie","Adam","Daniel","Brian","Eric","Chris","Liam","Harry","Will","Bill","Callum","Masry","Hanafi","Alberto Rodríguez","Jhenny","Anna","Peter","Marc Aurèle","Marie Line","Yasmin Alves","Lax","Skylar","Corey","Jacqueline","Blake","Pedro","Marta","Alloy","Ash","Ballad","Coral","Echo","Fable","Nova","Onyx","Sage","Shimmer","Nouran","Nermin","Othman","Layla","Nada","Mariam","Samir","Eman","Haneen","Fahd","Jasem","Marwa","Razan","Yehya","Hamdan","Zephyr","Puck","Charon","Kore","Fenrir","Leda","Orus","Aoede","Enceladus","Sulafat","Mina","Nina","Ruby","Mason","Rohan"],"example":"Corey","description":"Name of the voice for this agent."},"speed":{"type":"number","minimum":0.7,"maximum":1.2,"description":"Speech rate multiplier (0.7–1.2). Only supported on select voices; ignored for others.","example":1},"stability":{"type":"number","minimum":0,"maximum":1,"description":"Voice consistency (0–1). Higher values produce more consistent delivery. Only supported on select voices; ignored for others.","example":0.5},"similarity":{"type":"number","minimum":0,"maximum":1,"description":"How closely the output matches the reference voice sample (0–1). Only supported on select voices; ignored for others.","example":0.75},"instructions":{"type":"string","maxLength":500,"description":"Natural-language delivery instructions for the voice (max 500 chars). Only supported on select voices; ignored for others.","example":"Speak slowly and clearly."}},"required":["voiceName"],"description":"Text-to-speech voice configuration"},"transcriber":{"type":"object","properties":{"model":{"type":"string","enum":["elevenlabs/scribe_v2_realtime","cartesia/ink-2","cartesia/ink-whisper","deepgram/nova-3","deepgram/nova-2","deepgram/flux-general-multi","soniox/stt-rt-v5","soniox/stt-rt-v4","google/gemini-3.5-transcribe-live","hamsa/hamsa-ar"],"example":"soniox/stt-rt-v5","description":"Speech-to-text model to use for this agent."},"language":{"type":"string","description":"BCP-47 language code for speech recognition (e.g. \"en\", \"fr\", \"ar\"). Use \"multi\" for automatic detection. Valid codes depend on the selected model.","example":"multi"},"minSilenceDuration":{"type":"number","minimum":0.1,"maximum":3,"description":"Seconds of continuous silence that signals the user has finished speaking (0.1–3.0). Lower values make the agent respond faster but may cut off slow speakers.","example":0.75},"activationThreshold":{"type":"number","minimum":0,"maximum":1,"description":"Voice activity detection sensitivity (0–1). Lower values detect quieter speech but may pick up background noise. Higher values require clearer speech to activate.","example":0.5}},"required":["model","language","minSilenceDuration","activationThreshold"],"description":"Speech-to-text (voice input) configuration"},"recordings":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether voice calls are recorded and stored"},"retentionDays":{"type":"integer","minimum":0,"description":"How many days recordings are kept before automatic deletion. 0 disables storage even when enabled is true.","example":30}},"required":["enabled","retentionDays"],"description":"Call recording and retention settings"},"maxConcurrentSessions":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum simultaneous active voice calls for this agent. null = no limit.","example":5},{"type":"null","exclusiveMinimum":0,"description":"Maximum simultaneous active voice calls for this agent. null = no limit.","example":5}]},"maxCallDurationSeconds":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum length of a single call in seconds. The call ends automatically when reached. null = no limit.","example":900},{"type":"null","exclusiveMinimum":0,"description":"Maximum length of a single call in seconds. The call ends automatically when reached. null = no limit.","example":900}]},"maxDailyCallsPerUser":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum voice calls a single user can start per calendar day. null = no limit.","example":10},{"type":"null","exclusiveMinimum":0,"description":"Maximum voice calls a single user can start per calendar day. null = no limit.","example":10}]},"model":{"type":"string","enum":["gpt-oss-120b","gpt-oss-20b","gpt-5.2","gpt-5.5","gpt-5.6-terra","gpt-6.1-sol","gpt-6.1-terra","gpt-6-luna","claude-opus-5-5","claude-sonnet-5-5","claude-haiku-5-5","gemini-2.5-pro","gemini-3-flash","gemini-3.1-flash-lite","gemini-3.1-pro","gemini-3.5-flash-lite","gemini-3.6-flash","gemini-3.8-flash","grok-4.7","DeepSeek-V3.1","DeepSeek-R1","DeepSeek-V4-Flash","DeepSeek-V4.1-Flash","kimi-k2.6","mistral-medium-3.5","mistral-small-2603","glm-5.2","glm-5.3-flash","auto"],"description":"AI model used to generate responses during a voice call. Can be set independently from the chat model — faster, cheaper models are common here.","example":"gpt-6-luna"},"temperature":{"type":"number","minimum":0,"maximum":1,"description":"Randomness of voice responses (0–1). 0 = deterministic and focused, 1 = more varied and creative.","example":0},"allowInterruptions":{"type":"boolean","description":"When true the user can speak while the agent is talking and the agent will stop and listen. When false the agent finishes its turn before processing new speech."},"allowTextInput":{"type":"boolean","description":"When true users can also type messages during a voice session instead of only speaking."},"endConversationAfterSilenceSeconds":{"oneOf":[{"type":"integer","minimum":10,"description":"Seconds of inactivity before the session ends automatically. Minimum 10 seconds. null = session never auto-ends.","example":300},{"type":"null","minimum":10,"description":"Seconds of inactivity before the session ends automatically. Minimum 10 seconds. null = session never auto-ends.","example":300}]},"initialMessage":{"type":"string","maxLength":500,"description":"Message the agent speaks immediately when a voice session starts, before the user says anything. Leave empty to wait for the user to speak first (max 500 chars)."},"errorMessage":{"type":"string","maxLength":500,"description":"Fallback message spoken to the user when the agent encounters an unrecoverable error during a call (max 500 chars)."}},"description":"Voice mode configuration (null = disable voice mode)","uniqueKey":"voiceSettings.oneOf.1","typeLabel":"null"}],"uniqueKey":"voiceSettings","typeLabel":"object | null"},"blockedCountries":{"oneOf":[{"type":"array","items":{"type":"string","minLength":2,"maxLength":2,"uniqueKey":"blockedCountries.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":300,"description":"ISO 3166-1 alpha-2 country codes to block (null = remove all blocking)","example":["RU","KP"],"uniqueKey":"blockedCountries.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":2,"maxLength":2},"maxItems":300,"description":"ISO 3166-1 alpha-2 country codes to block (null = remove all blocking)","example":["RU","KP"],"uniqueKey":"blockedCountries.oneOf.1","typeLabel":"null"}],"uniqueKey":"blockedCountries","typeLabel":"string[] | null"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","instructions":"\u003cstring>","channelInstructions":{"chat_widget":"\u003cstring>","help_page":"\u003cstring>","center_stage":"\u003cstring>","side_panel":"\u003cstring>","slack":"\u003cstring>","whatsapp":"\u003cstring>","messenger":"\u003cstring>","instagram":"\u003cstring>","salesforce":"\u003cstring>","zendesk":"\u003cstring>","zendesk_messaging":"\u003cstring>","api":"\u003cstring>","email":"\u003cstring>","android_sdk":"\u003cstring>","ios_sdk":"\u003cstring>","phone":"\u003cstring>","search":"\u003cstring>"},"model":"gpt-5.6-terra","temp":0.5,"allowedDomains":["\u003cstring>"],"suggestedMessages":[{"text":"\u003cstring>","type":"single","order":123,"icon":"\u003cstring>"}],"initialMessages":["\u003cstring>"],"creditLimit":123,"notificationsSettings":{},"ipRateLimits":{"limit":20,"timeframe":240,"message":"Too many messages in a row"},"spamSettings":{"enabled":true,"prompt":"\u003cstring>"},"voiceSettings":{"maxConcurrentSessions":5,"maxCallDurationSeconds":900,"maxDailyCallsPerUser":10,"model":"gpt-6-luna","temperature":0,"allowInterruptions":true,"allowTextInput":true,"endConversationAfterSilenceSeconds":300,"initialMessage":"\u003cstring>","errorMessage":"\u003cstring>"},"blockedCountries":["RU","KP"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"532db088-5f68-4282-87d8-31dd064cd180":{"description":"Agent updated","content":{"application/json":{"schema":{"type":"object","properties":{"success":{"type":"boolean","enum":[true],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"}},"required":["success"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":true}}},"exampleType":"generated"}},"exampleType":"generated"},"2dec7c9d-4f45-462f-a897-e04959301918":{"description":"The request body failed schema validation. Inspect the `details` object in the error response for field-level errors.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"VALIDATION_INVALID_BODY","message":"Invalid request"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_INVALID_BODY","message":"Invalid request"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9fb0ac68-ccff-463f-a6b9-0ba5874ec358":{"description":"No Authorization header present. Provide a valid API key as a Bearer token in the Authorization header: `Authorization: Bearer \u003capi-key>`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"AUTH_MISSING_API_KEY","message":"Authentication required"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AUTH_MISSING_API_KEY","message":"Authentication required"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ce0b7e7f-759a-49f4-a4b0-5399df6e2342":{"description":"Your current plan does not include API access. Upgrade to the Basic plan or higher to use the API.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SUBSCRIPTION_API_RESTRICTED_PLAN","message":"A Basic plan or higher is required to access the API"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SUBSCRIPTION_API_RESTRICTED_PLAN","message":"A Basic plan or higher is required to access the API"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ed47f6ec-a13f-44e2-89ec-9455e35fc76e":{"description":"No agent matches the provided `agentId`, or it does not belong to the authenticated account.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"AGENT_NOT_FOUND","message":"Agent not found"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"AGENT_NOT_FOUND","message":"Agent not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"2ffdd310-2880-48cb-974c-54bcabdd7d17":{"description":"Rate limit exceeded. Check the `X-RateLimit-Reset` response header for the Unix epoch seconds when the limit resets.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"RATE_LIMIT_TOO_MANY_REQUESTS","message":"Too many requests, please try again later"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMIT_TOO_MANY_REQUESTS","message":"Too many requests, please try again later"}}}},"exampleType":"examples"}},"exampleType":"examples"},"d474ad5c-d1c3-4ea5-91cf-227d582ac8b5":{"description":"An unhandled server error occurred. If the issue persists, contact support with the `x-request-id` response header value for debugging.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"Something went wrong, please try again"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_SERVER_ERROR","message":"Something went wrong, please try again"}}}},"exampleType":"examples"}},"exampleType":"examples"},"69baa81e-3b7d-4eb2-b474-fb798076d211":{"description":"Chatbase is undergoing scheduled maintenance and the API is temporarily rejecting requests. This is transient; retry after a short delay. Requests are rejected before any data is read or written, so no partial changes are applied.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"error.details.additionalProperties","typeLabel":"string"},"description":"Field-level validation errors","uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"SERVICE_UNDER_MAINTENANCE","message":"The API is temporarily unavailable for scheduled maintenance, please try again later"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"SERVICE_UNDER_MAINTENANCE","message":"The API is temporarily unavailable for scheduled maintenance, please try again later"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"1600f3c9-0ed0-481a-b1bd-b2580df08e91":{"bearerAuth":{"type":"http","scheme":"bearer","description":"API key from your account settings","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"131cbcde-68c0-4c82-baf4-8793c7424f12":{"url":"https://www.chatbase.co/api/v2","description":"Chatbase API v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key from your account settings","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key from your account settings","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-v2-openapi.json"},"subdomain":"chatbase","siteName":"Chatbase","title":"Update agent - Chatbase","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-27T09:49:25.379Z","originalFileLocation":"api-reference/v2/agents/update-agent.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=\"Partially updates an agent. Only provided fields are changed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Chatbase\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_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=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update agent - Chatbase\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates an agent. Only provided fields are changed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Chatbase\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://chatbase.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+agent\u0026amp;description=Partially+updates+an+agent.+Only+provided+fields+are+changed.\u0026amp;theme=8967705c05e833213354143b\u0026amp;signature=5ccb3e1d183207201309bf1beefebbcb953a80213978b4e721867330fc0d991e\">\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=\"Update agent - Chatbase\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates an agent. Only provided fields are changed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://chatbase.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+agent\u0026amp;description=Partially+updates+an+agent.+Only+provided+fields+are+changed.\u0026amp;theme=8967705c05e833213354143b\u0026amp;signature=5ccb3e1d183207201309bf1beefebbcb953a80213978b4e721867330fc0d991e\">\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=\"/docs/mintlify-assets/_mintlify/favicons/chatbase/sZYcuOsK-Dv6V9lc/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Chatbase\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#18181b\">\u003clink data-mint-head rel=\"canonical\" href=\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/docs/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api-reference/v2/agents/update-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://www.chatbase.co/#organization\",\"name\":\"Chatbase\",\"url\":\"https://www.chatbase.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/chatbase/pJU9vM3D9oN_YQME/logo/light.svg?fit=max\u0026auto=format\u0026n=pJU9vM3D9oN_YQME\u0026q=85\u0026s=a45a73af7ac778cd0920dbb6ad1aaa93\"}},{\"@type\":\"WebSite\",\"@id\":\"https://www.chatbase.co/docs#website\",\"name\":\"Chatbase\",\"url\":\"https://www.chatbase.co/docs\",\"publisher\":{\"@id\":\"https://www.chatbase.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent#webpage\",\"url\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent\",\"name\":\"Update agent\",\"description\":\"Partially updates an agent. Only provided fields are changed.\",\"dateModified\":\"2026-10-27T09:49:25.379Z\",\"isPartOf\":{\"@id\":\"https://www.chatbase.co/docs#website\"},\"breadcrumb\":{\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Agents\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update agent\",\"item\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent#apireference\",\"headline\":\"Update agent\",\"name\":\"Update agent\",\"description\":\"Partially updates an agent. Only provided fields are changed.\",\"url\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent\",\"mainEntityOfPage\":{\"@id\":\"https://www.chatbase.co/docs/api-reference/v2/agents/update-agent#webpage\"},\"dateModified\":\"2026-10-27T09:49:25.379Z\",\"publisher\":{\"@id\":\"https://www.chatbase.co/#organization\"},\"isPartOf\":{\"@id\":\"https://www.chatbase.co/docs#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Chatbase\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Chatbase","nav":{"global":null,"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":"/user-guides/quick-start/introduction"}]},{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/developer-guides/overview"}]},{"tab":"API Reference","dropdowns":[{"dropdown":"API v2","icon":"code","groups":[{"group":"Getting Started","pages":[{"title":"API v2 Overview","sidebarTitle":"Overview","href":"/api-reference/v2/overview"},{"title":"Authentication","href":"/api-reference/v2/authentication"},{"title":"Streaming","href":"/api-reference/v2/streaming"},{"title":"Error Handling","href":"/api-reference/v2/error-handling"},{"title":"Pagination","href":"/api-reference/v2/pagination"}]},{"group":"Guides","pages":[{"title":"Agents","href":"/api-reference/v2/agents"},{"title":"User Conversations","href":"/api-reference/v2/user-conversations"},{"title":"Conversation Search","href":"/api-reference/v2/conversation-search"},{"title":"Sources","href":"/api-reference/v2/sources"},{"title":"Helpdesk","href":"/api-reference/v2/helpdesk"},{"title":"WhatsApp","href":"/api-reference/v2/whatsapp"},{"title":"Voice Sessions","href":"/api-reference/v2/voice"},{"title":"Client Actions","href":"/api-reference/v2/client-actions"}]},{"group":"Endpoints","pages":[{"group":"Health","pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /health","href":"/api-reference/v2/health/health-check"}]},{"group":"Agents","pages":[{"title":"List agents","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents","href":"/api-reference/v2/agents/list-agents"},{"title":"Create agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents","href":"/api-reference/v2/agents/create-agent"},{"title":"Get agent","description":"Returns a single agent by ID.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}","href":"/api-reference/v2/agents/get-agent"},{"title":"Update agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}","href":"/api-reference/v2/agents/update-agent"},{"title":"Delete agent","description":"Permanently deletes an agent and all its sources. Also disconnects any active integrations (Slack, WhatsApp, etc.). This action is irreversible.","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json delete /agents/{agentId}","href":"/api-reference/v2/agents/delete-agent"},{"title":"Update agent styles","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/styles","href":"/api-reference/v2/agents/update-agent-styles"},{"title":"Toggle auto-retrain","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/auto-retrain","href":"/api-reference/v2/agents/toggle-auto-retrain"},{"title":"Clone agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/clone","href":"/api-reference/v2/agents/clone-agent"},{"title":"Train agent (deprecated)","deprecated":true,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/train","href":"/api-reference/v2/agents/train-agent-deprecated"},{"title":"Chat with an agent","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/chat","href":"/api-reference/v2/agents/chat-with-an-agent"},{"title":"Retry a message","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/conversations/{conversationId}/retry","href":"/api-reference/v2/agents/retry-a-message"},{"title":"Start a voice session","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/voice/sessions","href":"/api-reference/v2/agents/start-a-voice-session"},{"title":"Submit a tool result","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/conversations/{conversationId}/tool-result","href":"/api-reference/v2/agents/submit-a-tool-result"}]},{"group":"Conversations","pages":[{"title":"List conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations","href":"/api-reference/v2/conversations/list-conversations"},{"title":"Export conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/export","href":"/api-reference/v2/conversations/export-conversations"},{"title":"Search conversations","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/search","href":"/api-reference/v2/conversations/search-conversations"},{"title":"Get a conversation","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/{conversationId}","href":"/api-reference/v2/conversations/get-a-conversation"},{"title":"Update conversation status","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/conversations/{conversationId}","href":"/api-reference/v2/conversations/update-conversation-status"},{"title":"List conversation messages","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/conversations/{conversationId}/messages","href":"/api-reference/v2/conversations/list-conversation-messages"},{"title":"List conversations for a user","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/users/{userId}/conversations","href":"/api-reference/v2/conversations/list-conversations-for-a-user"},{"title":"Update message feedback","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/conversations/{conversationId}/messages/{messageId}/feedback","href":"/api-reference/v2/conversations/update-message-feedback"}]},{"group":"Sources","pages":[{"title":"Get sources summary","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources/summary","href":"/api-reference/v2/sources/get-sources-summary"},{"title":"List sources","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources","href":"/api-reference/v2/sources/list-sources"},{"title":"Create source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/sources","href":"/api-reference/v2/sources/create-source"},{"title":"Get source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/get-source"},{"title":"Update source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/update-source"},{"title":"Delete source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json delete /agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/delete-source"},{"title":"Restore source (deprecated)","deprecated":true,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/sources/{sourceId}/restore","href":"/api-reference/v2/sources/restore-source-deprecated"},{"title":"Create file source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /api/v2/agents/{agentId}/sources","href":"/api-reference/v2/sources/create-file-source"},{"title":"Update file source","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json put /api/v2/agents/{agentId}/sources/{sourceId}","href":"/api-reference/v2/sources/update-file-source"}]},{"group":"WhatsApp","pages":[{"title":"List WhatsApp templates","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/whatsapp/templates","href":"/api-reference/v2/whatsapp/list-whatsapp-templates"},{"title":"Send a WhatsApp template message","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/whatsapp/messages/template","href":"/api-reference/v2/whatsapp/send-a-whatsapp-template-message"}]},{"group":"Helpdesk","pages":[{"title":"List ticket statuses","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/ticket-statuses","href":"/api-reference/v2/helpdesk/list-ticket-statuses"},{"title":"List teams","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/teams","href":"/api-reference/v2/helpdesk/list-teams"},{"title":"List tickets","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets","href":"/api-reference/v2/helpdesk/list-tickets"},{"title":"Create a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets","href":"/api-reference/v2/helpdesk/create-a-ticket"},{"title":"Search tickets","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets/search","href":"/api-reference/v2/helpdesk/search-tickets"},{"title":"Get a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets/{ticketNumber}","href":"/api-reference/v2/helpdesk/get-a-ticket"},{"title":"Update a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json patch /agents/{agentId}/helpdesk/tickets/{ticketNumber}","href":"/api-reference/v2/helpdesk/update-a-ticket"},{"title":"List ticket messages","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json get /agents/{agentId}/helpdesk/tickets/{ticketNumber}/messages","href":"/api-reference/v2/helpdesk/list-ticket-messages"},{"title":"Add a message to a ticket","deprecated":null,"version":null,"openapi":"/api-v2-openapi.json post /agents/{agentId}/helpdesk/tickets/{ticketNumber}/messages","href":"/api-reference/v2/helpdesk/add-a-message-to-a-ticket"}]}]}]},{"dropdown":"API v1","icon":"box-archive","groups":[{"group":"Getting Started","pages":[{"title":"API v1 Overview","sidebarTitle":"Overview","href":"/api-reference/v1/overview"}]},{"group":"Endpoints","pages":[{"group":"Chat","pages":[{"title":"Chat with a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chat","href":"/api-reference/v1/chat/chat-with-a-chatbot"}]},{"group":"Chatbots","pages":[{"title":"Create a new chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /create-chatbot","href":"/api-reference/v1/chatbots/create-a-new-chatbot"},{"title":"Get all chatbots","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-chatbots","href":"/api-reference/v1/chatbots/get-all-chatbots"},{"title":"Delete a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot","href":"/api-reference/v1/chatbots/delete-a-chatbot"},{"title":"Update a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /update-chatbot-data","href":"/api-reference/v1/chatbots/update-a-chatbot"},{"title":"Update chatbot settings","deprecated":null,"version":null,"openapi":"/openapi.yaml post /update-chatbot-settings","href":"/api-reference/v1/chatbots/update-chatbot-settings"}]},{"group":"Conversations","pages":[{"title":"Get conversations for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-conversations","href":"/api-reference/v1/conversations/get-conversations-for-a-chatbot"}]},{"group":"Leads","pages":[{"title":"Get leads for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /get-leads","href":"/api-reference/v1/leads/get-leads-for-a-chatbot"}]},{"group":"Assets","pages":[{"title":"Upload chatbot icon","deprecated":null,"version":null,"openapi":"/openapi.yaml post /upload-chatbot-icon","href":"/api-reference/v1/assets/upload-chatbot-icon"},{"title":"Upload chatbot profile picture","deprecated":null,"version":null,"openapi":"/openapi.yaml post /upload-chatbot-profile-picture","href":"/api-reference/v1/assets/upload-chatbot-profile-picture"},{"title":"Delete chatbot icon","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot-icon","href":"/api-reference/v1/assets/delete-chatbot-icon"},{"title":"Delete chatbot profile picture","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /delete-chatbot-profile-picture","href":"/api-reference/v1/assets/delete-chatbot-profile-picture"}]},{"group":"Contacts","pages":[{"title":"Get contacts for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/contacts","href":"/api-reference/v1/contacts/get-contacts-for-a-chatbot"},{"title":"Create contacts for a chatbot","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chatbots/{chatbotId}/contacts","href":"/api-reference/v1/contacts/create-contacts-for-a-chatbot"},{"title":"Get a specific contact","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/get-a-specific-contact"},{"title":"Delete a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/delete-a-contact"},{"title":"Update a contact","deprecated":null,"version":null,"openapi":"/openapi.yaml patch /chatbots/{chatbotId}/contacts/{contactId}","href":"/api-reference/v1/contacts/update-a-contact"},{"title":"Get custom attributes schema","deprecated":null,"version":null,"openapi":"/openapi.yaml get /chatbots/{chatbotId}/custom-attributes","href":"/api-reference/v1/contacts/get-custom-attributes-schema"},{"title":"Create custom attribute","deprecated":null,"version":null,"openapi":"/openapi.yaml post /chatbots/{chatbotId}/custom-attributes","href":"/api-reference/v1/contacts/create-custom-attribute"},{"title":"Update custom attribute","deprecated":null,"version":null,"openapi":"/openapi.yaml put /chatbots/{chatbotId}/custom-attributes/{name}","href":"/api-reference/v1/contacts/update-custom-attribute"}]}]}]}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"Help \u0026 Support","pages":[{"title":"Help \u0026 Support","href":"/faq/faq"}]}]},"title":"Update agent - Chatbase","buildId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","deploymentId":"dpl_GvhK4qVXq51DpfYJLCtPpYNN4YHN","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-Bg4Z7D_G.js","utils-Biz734EK.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C6F9YHs6.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BoJjY_VP.js","snippetPresets-CnZ-mOFh.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-DC_SB2pp.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BYKtOiIP.js","shallow-COAac_UD.js","getApiPlaygroundDisplay-BV4Viqi2.js","CodeSnippet-DDgW-JXl.js","CodeSnippets-CP1LpNhG.js","Page-BeiUfucV.js","getPastedJson-Cvgvbfmv.js","icon-D-H368xH.js","MethodPill-CXSxH1VW.js","DuplicateIcon-JcbBzF1x.js","createIcon-BDt_aHZM.js","DynamicMarkdown-DO1Fz7ar.js","SectionHeading-mwKBArs3.js","axios-vUo_bRtp.js","Markdown-C3KUTGJN.js","clsx-C6CAjViH.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C3vb5JQZ.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C8Hisf3g.js"]}