Can be set at agent level or campaign level. Null fields inherit from the parent level.
Hierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.
Can be set at agent level or campaign level. Null fields inherit from the parent level.
Hierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Kejue","colors":{"primary":"#E8663C","light":"#F0845E","dark":"#D14E24"},"logo":{"light":"https://mintcdn.com/kejue/2ObUTjaQylFOQGjC/logo/light.png?fit=max\u0026auto=format\u0026n=2ObUTjaQylFOQGjC\u0026q=85\u0026s=dfd84fd35a10607080f795c7b1623704","dark":"https://mintcdn.com/kejue/2ObUTjaQylFOQGjC/logo/dark.png?fit=max\u0026auto=format\u0026n=2ObUTjaQylFOQGjC\u0026q=85\u0026s=9a935421b87db169f844466e74babfa9"},"favicon":"https://mintcdn.com/kejue/2ObUTjaQylFOQGjC/favicon.svg?fit=max\u0026auto=format\u0026n=2ObUTjaQylFOQGjC\u0026q=85\u0026s=43863f06cc3513de85e758f10534f20b","api":{"playground":{}},"appearance":{"default":"system"},"footer":{"socials":{"website":"https://kejue.co"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"kejue","hasAudioNarration":false,"actualSubdomain":"kejue","customDomains":["docs.kejue.co"],"gitSource":{"type":"github","owner":"kejueai","repo":"documentation","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6a21b7772d20efc1fa8d43b5","collectionId":"f3005232-7199-40c7-9a68-011ecc2ee760","schemaVersion":"v2"},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ae9571c49f23bb02fa9d182:success","clientVersion":"0.0.4067","searchFilterCounts":[{"language":"default","tag":"API Reference","count":49},{"language":"default","tag":"Agents","count":13},{"language":"default","tag":"Documentation","count":11},{"language":"default","tag":"Campaigns","count":11},{"language":"default","tag":"Contacts","count":6},{"language":"default","tag":"Webhooks","count":6},{"language":"default","tag":"Core Concepts","count":5},{"language":"default","tag":"Guides","count":5},{"language":"default","tag":"Tools","count":5},{"language":"default","tag":"Calls","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":"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":"llms-txt-v2","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":"vite-origin","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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/agents/update-agent","slug":"/api-reference/agents/update-agent","pageMetadata":{"title":"Update Agent","description":"Update an agent.","deprecated":null,"version":null,"openapi":"/openapi.json patch /agents/{agent_id}","href":"/api-reference/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: \"Update an agent.\"\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":"Update an agent.","deprecated":null,"version":null,"openapi":"/openapi.json patch /agents/{agent_id}","href":"/api-reference/agents/update-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Agents"],"summary":"Update Agent","description":"Update an agent.","operationId":"update_agent_agents__agent_id__patch","security":["3f2192a0-df58-4949-b5d7-7f77a88b23b4"],"parameters":["85407c28-01f9-4573-b3b5-fbf59834f8f7"],"requestBody":"e379fc8f-3c3c-4453-abf3-9dd5f91dd150","responses":{"200":"024e1754-dfae-4be6-86ab-45c2467a9022","401":"bc06b3ed-6738-4f17-a143-220c49ac1745","404":"ecb275b1-b922-44c9-843d-d07c62009123","422":"26fc61dc-da6e-49cd-8101-8d9a72e7a1f1"},"method":"patch","type":"path","servers":["fb4503e1-75c0-486a-a896-6102f2d0cb18"],"path":"/agents/{agent_id}","baseUrlOptions":["https://api.kejue.co/api/v1"],"title":"Update Agent","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"85407c28-01f9-4573-b3b5-fbf59834f8f7":{"name":"agent_id","in":"path","required":true,"schema":{"type":"string","title":"Agent Id","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"name":{"oneOf":[{"type":"string","title":"Name","maxLength":255,"minLength":1,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Name","uniqueKey":"name.oneOf.1","typeLabel":"null"}],"uniqueKey":"name","typeLabel":"string | null"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"avatar":{"oneOf":[{"type":"string","title":"Avatar","uniqueKey":"avatar.oneOf.0","typeLabel":"string"},{"type":"null","title":"Avatar","uniqueKey":"avatar.oneOf.1","typeLabel":"null"}],"uniqueKey":"avatar","typeLabel":"string | null"},"is_active":{"oneOf":[{"type":"boolean","title":"Is Active","uniqueKey":"is_active.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Is Active","uniqueKey":"is_active.oneOf.1","typeLabel":"null"}],"uniqueKey":"is_active","typeLabel":"boolean | null"},"memory_enabled":{"oneOf":[{"type":"boolean","title":"Memory Enabled","uniqueKey":"memory_enabled.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Memory Enabled","uniqueKey":"memory_enabled.oneOf.1","typeLabel":"null"}],"uniqueKey":"memory_enabled","typeLabel":"boolean | null"},"call_settings":{"oneOf":[{"type":"object","title":"CallSettingsInput","description":"Unified call settings -- controls call window, retry, scoring, tags, and post-call behavior.\n\nCan be set at agent level or campaign level. Null fields inherit from the parent level.\nHierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.","example":{"allowed_days":[0,1,2,3,4],"auto_retry":true,"call_end_hour":17,"call_start_hour":9,"phone_assignment_mode":"local","retry_schedule":[60,240],"scoring_criteria":"Score 0-100 based on buying intent","structured_data_schema":[{"description":"Stated budget range","key":"budget"},{"description":"Decision timeline","key":"timeline"}],"tags":[{"description":"Contact expressed buying interest","name":"Interested"},{"description":"Contact requested a follow-up call","name":"Follow-up"}]},"properties":{"call_start_hour":{"oneOf":[{"type":"integer","title":"Call Start Hour","description":"Earliest hour to call (0-23, contact timezone). Default: 9","maximum":23,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_start_hour.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Start Hour","description":"Earliest hour to call (0-23, contact timezone). Default: 9","uniqueKey":"call_settings.oneOf.0.call_start_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_start_hour","typeLabel":"integer | null"},"call_start_minute":{"oneOf":[{"type":"integer","title":"Call Start Minute","description":"Earliest minute. Default: 0","maximum":59,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_start_minute.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Start Minute","description":"Earliest minute. Default: 0","uniqueKey":"call_settings.oneOf.0.call_start_minute.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_start_minute","typeLabel":"integer | null"},"call_end_hour":{"oneOf":[{"type":"integer","title":"Call End Hour","description":"Latest hour to call (0-23). Default: 18","maximum":23,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_end_hour.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call End Hour","description":"Latest hour to call (0-23). Default: 18","uniqueKey":"call_settings.oneOf.0.call_end_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_end_hour","typeLabel":"integer | null"},"call_end_minute":{"oneOf":[{"type":"integer","title":"Call End Minute","description":"Latest minute. Default: 0","maximum":59,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_end_minute.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call End Minute","description":"Latest minute. Default: 0","uniqueKey":"call_settings.oneOf.0.call_end_minute.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_end_minute","typeLabel":"integer | null"},"allowed_days":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Allowed Days","description":"Days of the week to call. 0=Monday, 6=Sunday. Default: [0,1,2,3,4] (Mon-Fri)","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Allowed Days","description":"Days of the week to call. 0=Monday, 6=Sunday. Default: [0,1,2,3,4] (Mon-Fri)","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.allowed_days","typeLabel":"integer[] | null"},"auto_retry":{"oneOf":[{"type":"boolean","title":"Auto Retry","description":"Retry when contact doesn't answer. Default: true","uniqueKey":"call_settings.oneOf.0.auto_retry.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Auto Retry","description":"Retry when contact doesn't answer. Default: true","uniqueKey":"call_settings.oneOf.0.auto_retry.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.auto_retry","typeLabel":"boolean | null"},"retry_schedule":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Retry Schedule","description":"Minutes between retries, e.g. [60, 240] = retry after 1h, then 4h. Default: [60, 240]","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Retry Schedule","description":"Minutes between retries, e.g. [60, 240] = retry after 1h, then 4h. Default: [60, 240]","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.retry_schedule","typeLabel":"integer[] | null"},"phone_assignment_mode":{"oneOf":[{"type":"string","title":"PhoneAssignmentMode","description":"How to pick the origin phone number. 'local' = match contact's country, 'foreign' = use a different country, 'any' = no preference. Default: 'any'","enum":["local","foreign","any"],"uniqueKey":"call_settings.oneOf.0.phone_assignment_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How to pick the origin phone number. 'local' = match contact's country, 'foreign' = use a different country, 'any' = no preference. Default: 'any'","uniqueKey":"call_settings.oneOf.0.phone_assignment_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.phone_assignment_mode","typeLabel":"enum\u003cstring> | null"},"scoring_criteria":{"oneOf":[{"type":"string","title":"Scoring Criteria","description":"Free-text instructions for scoring the call 0-100. Example: 'Score based on buying intent and engagement level'","uniqueKey":"call_settings.oneOf.0.scoring_criteria.oneOf.0","typeLabel":"string"},{"type":"null","title":"Scoring Criteria","description":"Free-text instructions for scoring the call 0-100. Example: 'Score based on buying intent and engagement level'","uniqueKey":"call_settings.oneOf.0.scoring_criteria.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.scoring_criteria","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","description":"Tag label, e.g. 'Interested'","isRequired":true,"uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"When to apply this tag -- the AI uses this to decide","isRequired":true,"uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["name","description"],"title":"TagDefinition","description":"A tag that can be applied to a call based on conversation content.","uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX]","typeLabel":"TagDefinition · object"},"title":"Tags","description":"Tag definitions -- AI applies matching tags after the call","uniqueKey":"call_settings.oneOf.0.tags.oneOf.0","typeLabel":"TagDefinition · object[]"},{"type":"null","title":"Tags","description":"Tag definitions -- AI applies matching tags after the call","uniqueKey":"call_settings.oneOf.0.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.tags","typeLabel":"TagDefinition · object[] | null"},"structured_data_schema":{"oneOf":[{"type":"array","items":{"properties":{"key":{"type":"string","title":"Key","description":"Output field key, e.g. 'budget'","isRequired":true,"uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX].key","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"What to extract from the conversation","isRequired":true,"uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["key","description"],"title":"StructuredDataField","description":"A field to extract from the conversation after the call.","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX]","typeLabel":"StructuredDataField · object"},"title":"Structured Data Schema","description":"Fields to extract from the conversation after the call","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0","typeLabel":"StructuredDataField · object[]"},{"type":"null","title":"Structured Data Schema","description":"Fields to extract from the conversation after the call","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.structured_data_schema","typeLabel":"StructuredDataField · object[] | null"},"server_url":{"oneOf":[{"type":"string","title":"Server Url","description":"URL to POST call events to (simple inline webhook)","uniqueKey":"call_settings.oneOf.0.server_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Server Url","description":"URL to POST call events to (simple inline webhook)","uniqueKey":"call_settings.oneOf.0.server_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.server_url","typeLabel":"string | null"},"server_secret":{"oneOf":[{"type":"string","title":"Server Secret","description":"HMAC-SHA256 signing secret for server_url","uniqueKey":"call_settings.oneOf.0.server_secret.oneOf.0","typeLabel":"string"},{"type":"null","title":"Server Secret","description":"HMAC-SHA256 signing secret for server_url","uniqueKey":"call_settings.oneOf.0.server_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.server_secret","typeLabel":"string | null"}},"uniqueKey":"call_settings.oneOf.0","typeLabel":"CallSettingsInput · object"},{"type":"null","uniqueKey":"call_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings","typeLabel":"CallSettingsInput · object | null"}},"type":"object","title":"UpdateAgent","description":"Partial update for an agent.","uniqueKey":"","typeLabel":"UpdateAgent · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","description":"\u003cstring>","avatar":"\u003cstring>","is_active":true,"memory_enabled":true,"call_settings":{"allowed_days":[0,1,2,3,4],"auto_retry":true,"call_end_hour":17,"call_start_hour":9,"phone_assignment_mode":"local","retry_schedule":[60,240],"scoring_criteria":"Score 0-100 based on buying intent","structured_data_schema":[{"description":"Stated budget range","key":"budget"},{"description":"Decision timeline","key":"timeline"}],"tags":[{"description":"Contact expressed buying interest","name":"Interested"},{"description":"Contact requested a follow-up call","name":"Follow-up"}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"024e1754-dfae-4be6-86ab-45c2467a9022":{"description":"Successful Response","content":{"application/json":{"schema":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"is_active":{"type":"boolean","title":"Is Active","isRequired":true,"uniqueKey":"is_active","typeLabel":"boolean"},"memory_enabled":{"type":"boolean","title":"Memory Enabled","isRequired":true,"uniqueKey":"memory_enabled","typeLabel":"boolean"},"description":{"oneOf":[{"type":"string","title":"Description","uniqueKey":"description.oneOf.0","typeLabel":"string"},{"type":"null","title":"Description","uniqueKey":"description.oneOf.1","typeLabel":"null"}],"uniqueKey":"description","typeLabel":"string | null"},"call_settings":{"oneOf":[{"type":"object","title":"CallSettingsInput","description":"Unified call settings -- controls call window, retry, scoring, tags, and post-call behavior.\n\nCan be set at agent level or campaign level. Null fields inherit from the parent level.\nHierarchy (lowest -> highest priority): System Defaults -> Workspace -> Agent -> Campaign -> API Override.","example":{"allowed_days":[0,1,2,3,4],"auto_retry":true,"call_end_hour":17,"call_start_hour":9,"phone_assignment_mode":"local","retry_schedule":[60,240],"scoring_criteria":"Score 0-100 based on buying intent","structured_data_schema":[{"description":"Stated budget range","key":"budget"},{"description":"Decision timeline","key":"timeline"}],"tags":[{"description":"Contact expressed buying interest","name":"Interested"},{"description":"Contact requested a follow-up call","name":"Follow-up"}]},"properties":{"call_start_hour":{"oneOf":[{"type":"integer","title":"Call Start Hour","description":"Earliest hour to call (0-23, contact timezone). Default: 9","maximum":23,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_start_hour.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Start Hour","description":"Earliest hour to call (0-23, contact timezone). Default: 9","uniqueKey":"call_settings.oneOf.0.call_start_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_start_hour","typeLabel":"integer | null"},"call_start_minute":{"oneOf":[{"type":"integer","title":"Call Start Minute","description":"Earliest minute. Default: 0","maximum":59,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_start_minute.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call Start Minute","description":"Earliest minute. Default: 0","uniqueKey":"call_settings.oneOf.0.call_start_minute.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_start_minute","typeLabel":"integer | null"},"call_end_hour":{"oneOf":[{"type":"integer","title":"Call End Hour","description":"Latest hour to call (0-23). Default: 18","maximum":23,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_end_hour.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call End Hour","description":"Latest hour to call (0-23). Default: 18","uniqueKey":"call_settings.oneOf.0.call_end_hour.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_end_hour","typeLabel":"integer | null"},"call_end_minute":{"oneOf":[{"type":"integer","title":"Call End Minute","description":"Latest minute. Default: 0","maximum":59,"minimum":0,"uniqueKey":"call_settings.oneOf.0.call_end_minute.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Call End Minute","description":"Latest minute. Default: 0","uniqueKey":"call_settings.oneOf.0.call_end_minute.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.call_end_minute","typeLabel":"integer | null"},"allowed_days":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Allowed Days","description":"Days of the week to call. 0=Monday, 6=Sunday. Default: [0,1,2,3,4] (Mon-Fri)","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Allowed Days","description":"Days of the week to call. 0=Monday, 6=Sunday. Default: [0,1,2,3,4] (Mon-Fri)","uniqueKey":"call_settings.oneOf.0.allowed_days.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.allowed_days","typeLabel":"integer[] | null"},"auto_retry":{"oneOf":[{"type":"boolean","title":"Auto Retry","description":"Retry when contact doesn't answer. Default: true","uniqueKey":"call_settings.oneOf.0.auto_retry.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Auto Retry","description":"Retry when contact doesn't answer. Default: true","uniqueKey":"call_settings.oneOf.0.auto_retry.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.auto_retry","typeLabel":"boolean | null"},"retry_schedule":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.0.items.[INDEX]","typeLabel":"integer"},"title":"Retry Schedule","description":"Minutes between retries, e.g. [60, 240] = retry after 1h, then 4h. Default: [60, 240]","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.0","typeLabel":"integer[]"},{"type":"null","title":"Retry Schedule","description":"Minutes between retries, e.g. [60, 240] = retry after 1h, then 4h. Default: [60, 240]","uniqueKey":"call_settings.oneOf.0.retry_schedule.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.retry_schedule","typeLabel":"integer[] | null"},"phone_assignment_mode":{"oneOf":[{"type":"string","title":"PhoneAssignmentMode","description":"How to pick the origin phone number. 'local' = match contact's country, 'foreign' = use a different country, 'any' = no preference. Default: 'any'","enum":["local","foreign","any"],"uniqueKey":"call_settings.oneOf.0.phone_assignment_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How to pick the origin phone number. 'local' = match contact's country, 'foreign' = use a different country, 'any' = no preference. Default: 'any'","uniqueKey":"call_settings.oneOf.0.phone_assignment_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.phone_assignment_mode","typeLabel":"enum\u003cstring> | null"},"scoring_criteria":{"oneOf":[{"type":"string","title":"Scoring Criteria","description":"Free-text instructions for scoring the call 0-100. Example: 'Score based on buying intent and engagement level'","uniqueKey":"call_settings.oneOf.0.scoring_criteria.oneOf.0","typeLabel":"string"},{"type":"null","title":"Scoring Criteria","description":"Free-text instructions for scoring the call 0-100. Example: 'Score based on buying intent and engagement level'","uniqueKey":"call_settings.oneOf.0.scoring_criteria.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.scoring_criteria","typeLabel":"string | null"},"tags":{"oneOf":[{"type":"array","items":{"properties":{"name":{"type":"string","title":"Name","description":"Tag label, e.g. 'Interested'","isRequired":true,"uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"When to apply this tag -- the AI uses this to decide","isRequired":true,"uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["name","description"],"title":"TagDefinition","description":"A tag that can be applied to a call based on conversation content.","uniqueKey":"call_settings.oneOf.0.tags.oneOf.0.items.[INDEX]","typeLabel":"TagDefinition · object"},"title":"Tags","description":"Tag definitions -- AI applies matching tags after the call","uniqueKey":"call_settings.oneOf.0.tags.oneOf.0","typeLabel":"TagDefinition · object[]"},{"type":"null","title":"Tags","description":"Tag definitions -- AI applies matching tags after the call","uniqueKey":"call_settings.oneOf.0.tags.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.tags","typeLabel":"TagDefinition · object[] | null"},"structured_data_schema":{"oneOf":[{"type":"array","items":{"properties":{"key":{"type":"string","title":"Key","description":"Output field key, e.g. 'budget'","isRequired":true,"uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX].key","typeLabel":"string"},"description":{"type":"string","title":"Description","description":"What to extract from the conversation","isRequired":true,"uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX].description","typeLabel":"string"}},"type":"object","required":["key","description"],"title":"StructuredDataField","description":"A field to extract from the conversation after the call.","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0.items.[INDEX]","typeLabel":"StructuredDataField · object"},"title":"Structured Data Schema","description":"Fields to extract from the conversation after the call","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.0","typeLabel":"StructuredDataField · object[]"},{"type":"null","title":"Structured Data Schema","description":"Fields to extract from the conversation after the call","uniqueKey":"call_settings.oneOf.0.structured_data_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.structured_data_schema","typeLabel":"StructuredDataField · object[] | null"},"server_url":{"oneOf":[{"type":"string","title":"Server Url","description":"URL to POST call events to (simple inline webhook)","uniqueKey":"call_settings.oneOf.0.server_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Server Url","description":"URL to POST call events to (simple inline webhook)","uniqueKey":"call_settings.oneOf.0.server_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.server_url","typeLabel":"string | null"},"server_secret":{"oneOf":[{"type":"string","title":"Server Secret","description":"HMAC-SHA256 signing secret for server_url","uniqueKey":"call_settings.oneOf.0.server_secret.oneOf.0","typeLabel":"string"},{"type":"null","title":"Server Secret","description":"HMAC-SHA256 signing secret for server_url","uniqueKey":"call_settings.oneOf.0.server_secret.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings.oneOf.0.server_secret","typeLabel":"string | null"}},"uniqueKey":"call_settings.oneOf.0","typeLabel":"CallSettingsInput · object"},{"type":"null","uniqueKey":"call_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"call_settings","typeLabel":"CallSettingsInput · object | null"},"voice_configs":{"items":{"properties":{"id":{"type":"string","title":"Id","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","title":"Name","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].name","typeLabel":"string"},"language_locale":{"type":"string","title":"Language Locale","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].language_locale","typeLabel":"string"},"prompt":{"type":"string","title":"Prompt","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].prompt","typeLabel":"string"},"first_speaker":{"type":"string","title":"First Speaker","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].first_speaker","typeLabel":"string"},"recording_enabled":{"type":"boolean","title":"Recording Enabled","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].recording_enabled","typeLabel":"boolean"},"silence_timeout":{"type":"integer","title":"Silence Timeout","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].silence_timeout","typeLabel":"integer"},"max_duration":{"type":"integer","title":"Max Duration","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].max_duration","typeLabel":"integer"},"is_default":{"type":"boolean","title":"Is Default","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].is_default","typeLabel":"boolean"},"is_active":{"type":"boolean","title":"Is Active","isRequired":true,"uniqueKey":"voice_configs.items.[INDEX].is_active","typeLabel":"boolean"},"first_message":{"oneOf":[{"type":"string","title":"First Message","uniqueKey":"voice_configs.items.[INDEX].first_message.oneOf.0","typeLabel":"string"},{"type":"null","title":"First Message","uniqueKey":"voice_configs.items.[INDEX].first_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].first_message","typeLabel":"string | null"},"first_message_uninterruptible":{"type":"boolean","title":"First Message Uninterruptible","default":false,"uniqueKey":"voice_configs.items.[INDEX].first_message_uninterruptible","typeLabel":"boolean"},"first_message_delay_ms":{"oneOf":[{"type":"integer","title":"First Message Delay Ms","uniqueKey":"voice_configs.items.[INDEX].first_message_delay_ms.oneOf.0","typeLabel":"integer"},{"type":"null","title":"First Message Delay Ms","uniqueKey":"voice_configs.items.[INDEX].first_message_delay_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].first_message_delay_ms","typeLabel":"integer | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","uniqueKey":"voice_configs.items.[INDEX].voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","uniqueKey":"voice_configs.items.[INDEX].voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].voice_id","typeLabel":"string | null"},"voice_name":{"oneOf":[{"type":"string","title":"Voice Name","uniqueKey":"voice_configs.items.[INDEX].voice_name.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Name","uniqueKey":"voice_configs.items.[INDEX].voice_name.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].voice_name","typeLabel":"string | null"},"model":{"oneOf":[{"type":"string","title":"Model","uniqueKey":"voice_configs.items.[INDEX].model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","uniqueKey":"voice_configs.items.[INDEX].model.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].model","typeLabel":"string | null"},"temperature":{"oneOf":[{"type":"number","title":"Temperature","uniqueKey":"voice_configs.items.[INDEX].temperature.oneOf.0","typeLabel":"number"},{"type":"null","title":"Temperature","uniqueKey":"voice_configs.items.[INDEX].temperature.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].temperature","typeLabel":"number | null"},"inactivity_messages":{"oneOf":[{"type":"array","items":{"additionalProperties":true,"type":"object","uniqueKey":"voice_configs.items.[INDEX].inactivity_messages.oneOf.0.items.[INDEX]","typeLabel":"object"},"title":"Inactivity Messages","uniqueKey":"voice_configs.items.[INDEX].inactivity_messages.oneOf.0","typeLabel":"Inactivity Messages · object[]"},{"type":"null","title":"Inactivity Messages","uniqueKey":"voice_configs.items.[INDEX].inactivity_messages.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].inactivity_messages","typeLabel":"Inactivity Messages · object[] | null"},"corpus_id":{"oneOf":[{"type":"string","title":"Corpus Id","uniqueKey":"voice_configs.items.[INDEX].corpus_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Corpus Id","uniqueKey":"voice_configs.items.[INDEX].corpus_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].corpus_id","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","title":"Created At","uniqueKey":"voice_configs.items.[INDEX].created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","uniqueKey":"voice_configs.items.[INDEX].created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","uniqueKey":"voice_configs.items.[INDEX].updated_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated At","uniqueKey":"voice_configs.items.[INDEX].updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice_configs.items.[INDEX].updated_at","typeLabel":"string | null"}},"type":"object","required":["id","name","language_locale","prompt","first_speaker","recording_enabled","silence_timeout","max_duration","is_default","is_active"],"title":"VoiceConfigResponse","description":"Voice configuration in API responses (public-safe).","uniqueKey":"voice_configs.items.[INDEX]","typeLabel":"VoiceConfigResponse · object"},"type":"array","title":"Voice Configs","uniqueKey":"voice_configs","typeLabel":"VoiceConfigResponse · object[]"},"tools":{"items":{"properties":{"tool_name":{"type":"string","title":"Tool Name","isRequired":true,"uniqueKey":"tools.items.[INDEX].tool_name","typeLabel":"string"},"channels":{"items":{"type":"string","uniqueKey":"tools.items.[INDEX].channels.items.[INDEX]","typeLabel":"string"},"type":"array","title":"Channels","isRequired":true,"uniqueKey":"tools.items.[INDEX].channels","typeLabel":"string[]"},"config":{"additionalProperties":true,"type":"object","title":"Config","isRequired":true,"uniqueKey":"tools.items.[INDEX].config","typeLabel":"Config · object"},"tool_id":{"oneOf":[{"type":"string","title":"Tool Id","uniqueKey":"tools.items.[INDEX].tool_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Tool Id","uniqueKey":"tools.items.[INDEX].tool_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"tools.items.[INDEX].tool_id","typeLabel":"string | null"}},"type":"object","required":["tool_name","channels","config"],"title":"AgentToolResponse","description":"A tool attached to an agent.","uniqueKey":"tools.items.[INDEX]","typeLabel":"AgentToolResponse · object"},"type":"array","title":"Tools","uniqueKey":"tools","typeLabel":"AgentToolResponse · object[]"},"created_at":{"oneOf":[{"type":"string","title":"Created At","uniqueKey":"created_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Created At","uniqueKey":"created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"created_at","typeLabel":"string | null"},"updated_at":{"oneOf":[{"type":"string","title":"Updated At","uniqueKey":"updated_at.oneOf.0","typeLabel":"string"},{"type":"null","title":"Updated At","uniqueKey":"updated_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"updated_at","typeLabel":"string | null"}},"type":"object","required":["id","name","is_active","memory_enabled"],"title":"AgentResponse","description":"Full agent (persona) response (public-safe).","uniqueKey":"","typeLabel":"AgentResponse · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","name":"\u003cstring>","is_active":true,"memory_enabled":true,"description":"\u003cstring>","call_settings":{"allowed_days":[0,1,2,3,4],"auto_retry":true,"call_end_hour":17,"call_start_hour":9,"phone_assignment_mode":"local","retry_schedule":[60,240],"scoring_criteria":"Score 0-100 based on buying intent","structured_data_schema":[{"description":"Stated budget range","key":"budget"},{"description":"Decision timeline","key":"timeline"}],"tags":[{"description":"Contact expressed buying interest","name":"Interested"},{"description":"Contact requested a follow-up call","name":"Follow-up"}]},"voice_configs":[{"id":"\u003cstring>","name":"\u003cstring>","language_locale":"\u003cstring>","prompt":"\u003cstring>","first_speaker":"\u003cstring>","recording_enabled":true,"silence_timeout":123,"max_duration":123,"is_default":true,"is_active":true,"first_message":"\u003cstring>","first_message_uninterruptible":false,"first_message_delay_ms":123,"voice_id":"\u003cstring>","voice_name":"\u003cstring>","model":"\u003cstring>","temperature":123,"inactivity_messages":[{}],"corpus_id":"\u003cstring>","created_at":"\u003cstring>","updated_at":"\u003cstring>"}],"tools":[{"tool_name":"\u003cstring>","channels":["\u003cstring>"],"config":{},"tool_id":"\u003cstring>"}],"created_at":"\u003cstring>","updated_at":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bc06b3ed-6738-4f17-a143-220c49ac1745":{"description":"Missing or invalid API key. Pass a workspace API key in the `X-API-Key` header.","content":{"application/json":{"example":{"error":"Invalid or missing API key","code":"UNAUTHORIZED","details":{}},"schema":{"properties":{"error":{"type":"string","title":"Error","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","required":["error","code"],"title":"ErrorResponse","description":"Standard error response.","example":{"code":"NOT_FOUND","details":{"contact_id":"123"},"error":"Contact not found"},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid or missing API key","code":"UNAUTHORIZED","details":{}}}},"exampleType":"examples"}},"exampleType":"examples"},"ecb275b1-b922-44c9-843d-d07c62009123":{"description":"Agent not found in this workspace.","content":{"application/json":{"example":{"error":"Agent not found","code":"NOT_FOUND","details":{"agent_id":"non_existent_id"}},"schema":{"properties":{"error":{"type":"string","title":"Error","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","required":["error","code"],"title":"ErrorResponse","description":"Standard error response.","example":{"code":"NOT_FOUND","details":{"contact_id":"123"},"error":"Contact not found"},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":"Agent not found","code":"NOT_FOUND","details":{"agent_id":"non_existent_id"}}}},"exampleType":"examples"}},"exampleType":"examples"},"26fc61dc-da6e-49cd-8101-8d9a72e7a1f1":{"description":"Request body or query parameters failed validation.","content":{"application/json":{"example":{"error":"Validation failed","code":"VALIDATION_ERROR","details":{"errors":[{"field":"body.name","message":"Field required","type":"missing"}]}},"schema":{"properties":{"error":{"type":"string","title":"Error","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","title":"Code","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"details":{"oneOf":[{"type":"object","title":"Details","additionalProperties":true,"uniqueKey":"details.oneOf.0","typeLabel":"Details · object"},{"type":"null","title":"Details","uniqueKey":"details.oneOf.1","typeLabel":"null"}],"uniqueKey":"details","typeLabel":"Details · object | null"}},"type":"object","required":["error","code"],"title":"ErrorResponse","description":"Standard error response.","example":{"code":"NOT_FOUND","details":{"contact_id":"123"},"error":"Contact not found"},"uniqueKey":"","typeLabel":"ErrorResponse · object"},"examples":{"Example":{"title":"Example","value":{"error":"Validation failed","code":"VALIDATION_ERROR","details":{"errors":[{"field":"body.name","message":"Field required","type":"missing"}]}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3f2192a0-df58-4949-b5d7-7f77a88b23b4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Workspace API key (e.g. `kej_live_...`)","scopes":[]}}},"servers":{"fb4503e1-75c0-486a-a896-6102f2d0cb18":{"url":"https://api.kejue.co/api/v1","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Workspace API key (e.g. `kej_live_...`)","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Workspace API key (e.g. `kej_live_...`)","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.json"},"subdomain":"kejue","siteName":"Kejue","title":"Update Agent - Kejue","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-29T10:12:53.755Z","originalFileLocation":"api-reference/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=\"Update an agent.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Kejue\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_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/kejue/iFx7a1lkBRv0Dv_3/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Agent - Kejue\">\u003cmeta data-mint-head property=\"og:description\" content=\"Update an agent.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Kejue\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.kejue.co/api-reference/agents/update-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://kejue.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+Agent\u0026amp;description=Update+an+agent.\u0026amp;theme=6decaf86883fbea8aa860731\u0026amp;signature=93556762845277868ea734aa8c82149053223d796af58eb92f63e112efda968a\">\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 - Kejue\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Update an agent.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://kejue.mintlify.app/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+Agent\u0026amp;description=Update+an+agent.\u0026amp;theme=6decaf86883fbea8aa860731\u0026amp;signature=93556762845277868ea734aa8c82149053223d796af58eb92f63e112efda968a\">\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/kejue/iFx7a1lkBRv0Dv_3/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Kejue\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#E8663C\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.kejue.co/api-reference/agents/update-agent\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/agents/update-agent.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.kejue.co/#organization\",\"name\":\"Kejue\",\"url\":\"https://docs.kejue.co\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/kejue/2ObUTjaQylFOQGjC/logo/light.png?fit=max\u0026auto=format\u0026n=2ObUTjaQylFOQGjC\u0026q=85\u0026s=dfd84fd35a10607080f795c7b1623704\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.kejue.co#website\",\"name\":\"Kejue\",\"url\":\"https://docs.kejue.co\",\"publisher\":{\"@id\":\"https://docs.kejue.co/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.kejue.co/api-reference/agents/update-agent#webpage\",\"url\":\"https://docs.kejue.co/api-reference/agents/update-agent\",\"name\":\"Update Agent\",\"description\":\"Update an agent.\",\"dateModified\":\"2026-05-29T10:12:53.755Z\",\"isPartOf\":{\"@id\":\"https://docs.kejue.co#website\"},\"breadcrumb\":{\"@id\":\"https://docs.kejue.co/api-reference/agents/update-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.kejue.co/api-reference/agents/update-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.kejue.co/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Agent\",\"item\":\"https://docs.kejue.co/api-reference/agents/update-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.kejue.co/api-reference/agents/update-agent#apireference\",\"headline\":\"Update Agent\",\"name\":\"Update Agent\",\"description\":\"Update an agent.\",\"url\":\"https://docs.kejue.co/api-reference/agents/update-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.kejue.co/api-reference/agents/update-agent#webpage\"},\"dateModified\":\"2026-05-29T10:12:53.755Z\",\"publisher\":{\"@id\":\"https://docs.kejue.co/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.kejue.co#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Kejue\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Kejue","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"square-terminal","groups":[{"group":"Agents","pages":[{"title":"List Agents","deprecated":null,"version":null,"openapi":"/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/openapi.json post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get Agent","deprecated":null,"version":null,"openapi":"/openapi.json get /agents/{agent_id}","href":"/api-reference/agents/get-agent"},{"title":"Delete Agent","description":"Delete an agent.","deprecated":null,"version":null,"openapi":"/openapi.json delete /agents/{agent_id}","href":"/api-reference/agents/delete-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/openapi.json patch /agents/{agent_id}","href":"/api-reference/agents/update-agent"},{"title":"List Voice Configs","description":"List all voice configurations for an agent.","deprecated":null,"version":null,"openapi":"/openapi.json get /agents/{agent_id}/voice-configs","href":"/api-reference/agents/list-voice-configs"},{"title":"Create Voice Config","deprecated":null,"version":null,"openapi":"/openapi.json post /agents/{agent_id}/voice-configs","href":"/api-reference/agents/create-voice-config"},{"title":"Delete Voice Config","deprecated":null,"version":null,"openapi":"/openapi.json delete /agents/{agent_id}/voice-configs/{config_id}","href":"/api-reference/agents/delete-voice-config"},{"title":"Update Voice Config","deprecated":null,"version":null,"openapi":"/openapi.json patch /agents/{agent_id}/voice-configs/{config_id}","href":"/api-reference/agents/update-voice-config"},{"title":"List Agent Tools","deprecated":null,"version":null,"openapi":"/openapi.json get /agents/{agent_id}/tools","href":"/api-reference/agents/list-agent-tools"},{"title":"Attach Tool","deprecated":null,"version":null,"openapi":"/openapi.json post /agents/{agent_id}/tools","href":"/api-reference/agents/attach-tool"},{"title":"Detach Tool","deprecated":null,"version":null,"openapi":"/openapi.json delete /agents/{agent_id}/tools/{tool_name}","href":"/api-reference/agents/detach-tool"},{"title":"Create Agent Call","deprecated":null,"version":null,"openapi":"/openapi.json post /agents/{agent_id}/calls","href":"/api-reference/agents/create-agent-call"}]},{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Create Call","deprecated":null,"version":null,"openapi":"/openapi.json post /calls","href":"/api-reference/calls/create-call"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/openapi.json get /calls/{job_id}","href":"/api-reference/calls/get-call"},{"title":"Inject Context","deprecated":null,"version":null,"openapi":"/openapi.json post /calls/{call_id}/inject-context","href":"/api-reference/calls/inject-context"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{campaign_id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Delete Campaign","deprecated":null,"version":null,"openapi":"/openapi.json delete /campaigns/{campaign_id}","href":"/api-reference/campaigns/delete-campaign"},{"title":"List Campaign Contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{campaign_id}/contacts","href":"/api-reference/campaigns/list-campaign-contacts"},{"title":"List Campaign Calls","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{campaign_id}/calls","href":"/api-reference/campaigns/list-campaign-calls"},{"title":"Get Campaign Analytics","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{campaign_id}/analytics","href":"/api-reference/campaigns/get-campaign-analytics"},{"title":"Get Campaign Progress","deprecated":null,"version":null,"openapi":"/openapi.json get /campaigns/{campaign_id}/progress","href":"/api-reference/campaigns/get-campaign-progress"},{"title":"Start Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{campaign_id}/start","href":"/api-reference/campaigns/start-campaign"},{"title":"Pause Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{campaign_id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"openapi":"/openapi.json post /campaigns/{campaign_id}/cancel","href":"/api-reference/campaigns/cancel-campaign"}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Bulk Create Contacts","deprecated":null,"version":null,"openapi":"/openapi.json post /contacts/bulk","href":"/api-reference/contacts/bulk-create-contacts"},{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/openapi.json get /contacts/{contact_id}","href":"/api-reference/contacts/get-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/openapi.json delete /contacts/{contact_id}","href":"/api-reference/contacts/delete-contact"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/openapi.json patch /contacts/{contact_id}","href":"/api-reference/contacts/update-contact"}]},{"group":"Models","pages":[{"title":"List Models","deprecated":null,"version":null,"openapi":"/openapi.json get /models","href":"/api-reference/models/list-models"}]},{"group":"Persona Calls","pages":[{"title":"Create Persona Call","deprecated":null,"version":null,"openapi":"/openapi.json post /persona-calls","href":"/api-reference/persona-calls/create-persona-call"}]},{"group":"Phone Numbers","pages":[{"title":"List Phone Numbers","deprecated":null,"version":null,"openapi":"/openapi.json get /phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"}]},{"group":"Tools","pages":[{"title":"List Tools","deprecated":null,"version":null,"openapi":"/openapi.json get /tools","href":"/api-reference/tools/list-tools"},{"title":"Create Tool","deprecated":null,"version":null,"openapi":"/openapi.json post /tools","href":"/api-reference/tools/create-tool"},{"title":"Get Tool","deprecated":null,"version":null,"openapi":"/openapi.json get /tools/{tool_id}","href":"/api-reference/tools/get-tool"},{"title":"Delete Tool","deprecated":null,"version":null,"openapi":"/openapi.json delete /tools/{tool_id}","href":"/api-reference/tools/delete-tool"},{"title":"Update Tool","deprecated":null,"version":null,"openapi":"/openapi.json patch /tools/{tool_id}","href":"/api-reference/tools/update-tool"}]},{"group":"Voices","pages":[{"title":"List Voices","deprecated":null,"version":null,"openapi":"/openapi.json get /voices","href":"/api-reference/voices/list-voices"}]},{"group":"Webhooks","pages":[{"title":"List Available Events","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/events","href":"/api-reference/webhooks/list-available-events"},{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook","deprecated":null,"version":null,"openapi":"/openapi.json get /webhooks/{webhook_id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/openapi.json delete /webhooks/{webhook_id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/openapi.json patch /webhooks/{webhook_id}","href":"/api-reference/webhooks/update-webhook"}]}]}]},"basePath":"","title":"Update Agent - Kejue","buildId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","deploymentId":"dpl_9VVk5y1P8k1ATeJguVngy9Q3cmbD","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DX1Meug0.js","utils-B_OMIQVC.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-ChxhRPMa.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CuKvD8Iv.js","snippetPresets-C5d7p2hp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CfHcE8m4.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-C1zZV314.js","shallow-CmQhqCJn.js","getApiPlaygroundDisplay-YRo9s1O7.js","CodeSnippet-RN1MTdfk.js","CodeSnippets-DKLPHxJA.js","Page-BAvA99GL.js","getPastedJson-bz0M41mU.js","icon-CsmhpPrv.js","MethodPill-CNGsVE77.js","DuplicateIcon-DilfU_Z2.js","createIcon-BdsYzQck.js","DynamicMarkdown-CbqEDjbV.js","SectionHeading-O6hXpFCN.js","axios-vUo_bRtp.js","Markdown-nKm-uidQ.js","clsx-ClVdStUn.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CIQkMg3R.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ImrFS4Fy.js"]}