curl --request PATCH \ --url https://app.thinnest.ai/api/v1/agents/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?", "temperature": 0.4, "widget": { "accent": "#0f766e" }, "voice": { "pastConversations": "recap", "detectMachines": true }}'
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
greeting: 'Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?',
temperature: 0.4,
widget: {accent: '#0f766e'},
voice: {pastConversations: 'recap', detectMachines: true}
})
};
fetch('https://app.thinnest.ai/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests
url = "https://app.thinnest.ai/api/v1/agents/{id}"
payload = {
"greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?",
"temperature": 0.4,
"widget": { "accent": "#0f766e" },
"voice": {
"pastConversations": "recap",
"detectMachines": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)
{ "id": "ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71", "name": "Skyline Sales", "instructions": "You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.", "greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?", "businessDescription": "Skyline Homes builds 2 and 3 BHK apartments in Pune.", "model": "prana-voice", "temperature": 0.4, "maxReplyTokens": 300, "language": "Hindi", "secondLanguage": null, "escalation": { "onNoAnswer": false, "onRequest": true }, "captureLeads": true, "ownRules": false, "scheduleCallbacks": false, "steps": [], "widget": { "theme": "classic", "accent": "#0f766e", "height": 806, "welcomeScreen": true, "welcomeCollectLeads": true }, "voice": { "answersCalls": true, "surfaces": [ "web", "whatsapp", "phone" ], "voice": "priya", "phoneNumber": "+918047361290", "language": null, "summariseCalls": true, "detectMachines": true, "recordCalls": true, "maxCallSeconds": 300, "pastConversations": "recap", "unavailableMessage": null, "unavailableMessageNote": null, "callStartUrl": null, "thinking": true, "thinkingLines": [], "thinkingDelayMs": 900, "thinkingRepeatMs": 2500, "thinkingAtTurnEnd": false, "turnSilenceSeconds": null, "turnDetection": null, "reaskAfterSeconds": null, "recordDoNotCall": true, "interruptWords": 3, "neverInterrupt": false, "earlyAnswers": true, "holdShortSpeech": true, "greetingUninterruptible": false, "ambience": null, "ambienceVolume": 0.15, "endCallOnFinish": false, "nudgeAfterSeconds": null, "nudges": 1, "nudgePhrase": null, "endAfterSilenceSeconds": null, "endPhrases": [], "callInstructions": null }, "byok": "workspace", "collectFields": [], "webKey": "pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ", "createdAt": "2026-09-17T09:39:31.204Z"}
Agents
Update Agent
Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.
PATCH
/
agents
/
{id}
Update Agent
curl --request PATCH \ --url https://app.thinnest.ai/api/v1/agents/{id} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?", "temperature": 0.4, "widget": { "accent": "#0f766e" }, "voice": { "pastConversations": "recap", "detectMachines": true }}'
const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
greeting: 'Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?',
temperature: 0.4,
widget: {accent: '#0f766e'},
voice: {pastConversations: 'recap', detectMachines: true}
})
};
fetch('https://app.thinnest.ai/api/v1/agents/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
import requests
url = "https://app.thinnest.ai/api/v1/agents/{id}"
payload = {
"greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?",
"temperature": 0.4,
"widget": { "accent": "#0f766e" },
"voice": {
"pastConversations": "recap",
"detectMachines": True
}
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)
{ "id": "ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71", "name": "Skyline Sales", "instructions": "You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.", "greeting": "Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?", "businessDescription": "Skyline Homes builds 2 and 3 BHK apartments in Pune.", "model": "prana-voice", "temperature": 0.4, "maxReplyTokens": 300, "language": "Hindi", "secondLanguage": null, "escalation": { "onNoAnswer": false, "onRequest": true }, "captureLeads": true, "ownRules": false, "scheduleCallbacks": false, "steps": [], "widget": { "theme": "classic", "accent": "#0f766e", "height": 806, "welcomeScreen": true, "welcomeCollectLeads": true }, "voice": { "answersCalls": true, "surfaces": [ "web", "whatsapp", "phone" ], "voice": "priya", "phoneNumber": "+918047361290", "language": null, "summariseCalls": true, "detectMachines": true, "recordCalls": true, "maxCallSeconds": 300, "pastConversations": "recap", "unavailableMessage": null, "unavailableMessageNote": null, "callStartUrl": null, "thinking": true, "thinkingLines": [], "thinkingDelayMs": 900, "thinkingRepeatMs": 2500, "thinkingAtTurnEnd": false, "turnSilenceSeconds": null, "turnDetection": null, "reaskAfterSeconds": null, "recordDoNotCall": true, "interruptWords": 3, "neverInterrupt": false, "earlyAnswers": true, "holdShortSpeech": true, "greetingUninterruptible": false, "ambience": null, "ambienceVolume": 0.15, "endCallOnFinish": false, "nudgeAfterSeconds": null, "nudges": 1, "nudgePhrase": null, "endAfterSilenceSeconds": null, "endPhrases": [], "callInstructions": null }, "byok": "workspace", "collectFields": [], "webKey": "pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ", "createdAt": "2026-09-17T09:39:31.204Z"}
Authorizations
Authorization
string
header
required
Your API key (ta_live_…) from Settings → API keys, sent as Authorization: Bearer <key>. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with 403.
Headers
Thinnest-Workspace
string
Developers only: the customer workspace this request acts in — its org_… id from POST /customers. Leave it out to act in your own workspace. Refused with 404 (Workspace not found.) when the id is unknown, is not one of your customers, or is not an org_… id; 410 when that customer was deleted (restore it with POST /customers/{id}/restore until it is erased); 403 when the key belongs to one customer workspace (it cannot act as another); 400 when your workspace is not a developer workspace. /customers/* and GET /customers/usage are your own workspace's and refuse the header with 400: call them without it.
Example:
"org_3fKq9TzQ1mN8vB2xR7cLpA"
Path Parameters
id
string
required
The agent's id (ag_…), as List Agents returns it. Another workspace's agent is the same 404 as one that never existed.
Body
application/json
Any subset of the agent's fields. At least one must be a field this API knows.
name
string
The agent's name, 2 to 60 characters, without hidden characters or markup.
Required string length: 2 - 60
instructions
string
What the agent is and how it behaves. Re-sent on every reply, so every character costs on every turn.
Maximum string length: 20000
greeting
string
The first thing it says on a call or in a chat. An empty string clears it.
Maximum string length: 200
businessDescription
string
One line about what the business is. Facts belong in Knowledge.
Maximum string length: 200
model
string | null
A model id from List Models, or null to put the agent back on the default model (Prana [Voice]) — the way back to the defaults; the plan and call rules below still apply to it. An empty string is a 400. Checked only when it changes, against the console's one model picker for chat and calls alike: on your plan, quick enough to answer a call (voice: true), within the per-minute budget a call can carry, and not one of our voice-only models. A chat-only agent is held to the same list, as in the console.
temperature
number
How adventurous the wording is. Clamped to 0–2.
Required range: 0 <= x <= 2
maxReplyTokens
number
The longest a reply may be, in tokens, for chat and calls alike. Rounded and clamped to 100–800.
Required range: 100 <= x <= 800
languages
string[]
The languages the agent speaks, by their English names: [] is auto (reply in the customer's language), one name is that language alone, and two to four make the agent expect those languages, the first being the one it falls back to when it cannot tell. On a phone call the recogniser works out the language among them. Send languages or language, not both: language sets one language and clears this list. A name the console does not offer, a repeat, or more than four is refused with a 400.
Maximum array length: 4
language
string
auto to reply in the customer's language, or a language the console offers by its English name, e.g. Hindi, Tamil, English.
secondLanguage
string | null
deprecated
Retired. Accepted so an older integration keeps working, but ignored: the agent answers in language alone.
escalation
object
When the agent hands over to a person. Send either or both.
Show child attributes
Example:
{ "onNoAnswer": false, "onRequest": true }
captureLeads
boolean
Take a name, email or phone number from an interested customer.
ownRules
boolean
true leaves out the platform's own lead, hand-over and call-back sentences, for a business that writes those rules in its instructions. Left out: the sentence about asking for details (or that the business does not collect them), the hand-over rule (or that nobody can be handed to, and that nobody should promise a follow-up) and the "cannot book a call back" sentence. Kept whatever you send: the boundary, the AI disclosure, the reply language, the date, your own instructions, and how a call is put through to a person.
scheduleCallbacks
boolean
Allow it to book a call back when asked.
welcomeScreen
boolean
Open the website widget on a welcome screen.
welcomeCollectLeads
boolean
Ask for the visitor's details on the welcome screen.
steps
object[]
The conversation script, in order, replacing the whole script. [] removes it.
Maximum array length: 12
Show child attributes
byok
enum<string> | null
How this agent uses the workspace's own provider keys (Bring your own keys). null (or workspace) follows the workspace: its default scope applies when it brings its own keys. off never does: our voices and models at our normal pricing, whatever the workspace does, and the model is not held to the voice-only-BYOK model list. all, voice, llm or llm_voice runs this agent on that scope's keys whatever the workspace default is; refused with 409 naming the missing key unless the workspace holds verified keys for every kind that scope needs. If a key goes later, the agent falls back to the workspace's scope at the next call. Omit the field to leave it unchanged; saved BYOK model and voice choices are kept but not used while it is off. Read back as workspace when it follows the workspace.
How the agent handles calls. Send any subset. Where an agent has no voice channel yet, sending any of these creates one — switched OFF, so setting only a voice or a message never starts it taking calls; send answersCalls: true to switch it on.
The details to fill in after every call, replacing the list. [] or null stops collecting; records already taken are kept.
Maximum array length: 30
Show child attributes
Response
The agent after the change.
An agent as the console shows it.
id
string
required
The agent's id.
Example:
"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71"
name
string
required
The agent's name, 2 to 60 characters.
instructions
string
required
What the agent is and how it behaves — its standing prompt.
greeting
string
required
The first thing it says, or an empty string.
businessDescription
string
required
One line about the business, or an empty string.
model
string | null
required
A model id from List Models. null when the agent is on a model that has since been retired.
temperature
number
required
How adventurous the wording is.
Required range: 0 <= x <= 2
maxReplyTokens
integer
required
The longest a reply may be, in tokens — one ceiling for chat and calls.
Required range: 100 <= x <= 800
language
string
required
auto (reply in the customer's language) or the language it always replies in, e.g. Hindi. When the agent is set to speak several languages this is auto: read languages.
languages
string[]
required
The languages the agent speaks, as the console shows them: [] is auto, one name is that language alone, and two to four are the languages it expects, the first being the one it falls back to.
secondLanguage
string | null
required
deprecated
Retired — always null. An agent answers in one language, language. Still returned so a client that reads it keeps working.
escalation
object
required
When the agent hands the conversation to a person on your team.
Show child attributes
captureLeads
boolean
required
Whether it takes a name, email or phone number from an interested customer.
ownRules
boolean
required
true leaves out the platform's own lead, hand-over and call-back sentences, for a business that writes those rules in its instructions. Left out: the sentence about asking for details (or that the business does not collect them), the hand-over rule (or that nobody can be handed to, and that nobody should promise a follow-up) and the "cannot book a call back" sentence. Kept whatever you send: the boundary, the AI disclosure, the reply language, the date, your own instructions, and how a call is put through to a person.
scheduleCallbacks
boolean
required
Whether it may book a call back when asked.
steps
object[]
required
Its conversation script, in order.
Show child attributes
widget
object
required
The website chat widget's look.
Show child attributes
voice
object | null
required
How it handles calls. null when the agent has no voice channel (a deployment without voice).
Show child attributes
byok
enum<string>
required
How this agent uses the workspace's own provider keys (Bring your own keys). null (or workspace) follows the workspace: its default scope applies when it brings its own keys. off never does: our voices and models at our normal pricing, whatever the workspace does, and the model is not held to the voice-only-BYOK model list. all, voice, llm or llm_voice runs this agent on that scope's keys whatever the workspace default is; refused with 409 naming the missing key unless the workspace holds verified keys for every kind that scope needs. If a key goes later, the agent falls back to the workspace's scope at the next call. Omit the field to leave it unchanged; saved BYOK model and voice choices are kept but not used while it is off. Read back as workspace when it follows the workspace.
Available options:
workspace,
off,
all,
voice,
llm,
llm_voice
collectFields
object[]
required
The details it fills in after every call, in the shape a call's extract takes. Empty when it collects nothing.
Show child attributes
webKey
string | null
required
The public key the website widget embeds (pk_…). It is published on your site, so it is not a secret.
createdAt
string<date-time>
required
When the agent was made.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"ThinnestAI","description":"One AI agent that answers on your website, WhatsApp and Telegram — and remembers the same customer across all of them.","colors":{"primary":"#ff4e01","light":"#ff7a3d","dark":"#e64600"},"logo":{"light":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/light.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=b9c83749f4bae8ed15285bc7d2b3dec4","dark":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/dark.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=e25aa9f9221cebcb813fa71c39f72037"},"favicon":"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/favicon.png?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=71b74c45d3942ee0cf5d5fec76b24991","api":{"playground":{"display":"interactive"},"examples":{"languages":["curl","javascript","python"]}},"navbar":{"primary":{"type":"button","label":"Open the console","href":"https://thinnest.ai/app"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"thinnestai","hasAudioNarration":false,"actualSubdomain":"thinnestai","customDomains":["docs.thinnest.ai"],"gitSource":{"type":"github","owner":"ashutoshkaremore","repo":"thin-agents-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6b002145a30465d2cf3f4c1f","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API reference","count":213},{"language":"default","tag":"Documentation","count":59},{"language":"default","tag":"Guides","count":15},{"language":"default","tag":"Tools","count":15},{"language":"default","tag":"Channels","count":14},{"language":"default","tag":"Phone numbers","count":13},{"language":"default","tag":"Your agent","count":12},{"language":"default","tag":"Reaching out","count":10},{"language":"default","tag":"Agents","count":10},{"language":"default","tag":"Customers","count":9}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","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":"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/agents/update-agent","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A \", _jsx(_components.strong, {\n children: \"build\"\n }), \" key may do this.\"]\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":"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A **build** key may do this.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/agents/update-agent","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Update Agent","operationId":"updateAgent","tags":["Agents"],"description":"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A **build** key may do this.","requestBody":"a6312818-d493-484c-84ac-87c1abb6d575","responses":{"200":"371fc438-fa61-45a3-8add-b5729e7e9606","400":"f7ec7ef3-3eb1-4868-b3d6-335b754b5a0c","401":"2058c030-0678-4951-be0d-64cf1f195408","403":"0bf9f929-5246-4a82-abc1-69c212e83d29","404":"685dd2d4-5e4c-43cf-adac-b1cd136100fd","409":"7bc943dd-0177-4d5a-a657-3714be6d1913","410":"322ae7e5-8d52-494b-b22b-01b17bd6b45f","429":"14033919-52ab-423b-972b-754f2c75e51c","500":"f8215371-285b-496c-9518-db869f2115cd","503":"8f17d88a-3ae1-406f-9dde-10c4b09f6277"},"parameters":["baeb0d52-72ef-4eb5-9001-8bd1020c4879"],"method":"patch","type":"path","servers":["554b68ba-71a0-4ba5-bf79-928576071426"],"security":["2ab51cb1-4826-4aaf-a310-84af0597cd2d"],"path":"/agents/{id}","baseUrlOptions":["https://app.thinnest.ai/api/v1"],"title":"Update Agent","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"baeb0d52-72ef-4eb5-9001-8bd1020c4879":{"name":"Thinnest-Workspace","in":"header","required":false,"description":"Developers only: the customer workspace this request acts in — its `org_…` id from `POST /customers`. Leave it out to act in your own workspace. Refused with `404` (`Workspace not found.`) when the id is unknown, is not one of your customers, or is not an `org_…` id; `410` when that customer was deleted (restore it with `POST /customers/{id}/restore` until it is erased); `403` when the key belongs to one customer workspace (it cannot act as another); `400` when your workspace is not a developer workspace. `/customers/*` and `GET /customers/usage` are your own workspace's and refuse the header with `400`: call them without it.","schema":{"type":"string","example":"org_3fKq9TzQ1mN8vB2xR7cLpA","isRequired":false,"description":"Developers only: the customer workspace this request acts in — its `org_…` id from `POST /customers`. Leave it out to act in your own workspace. Refused with `404` (`Workspace not found.`) when the id is unknown, is not one of your customers, or is not an `org_…` id; `410` when that customer was deleted (restore it with `POST /customers/{id}/restore` until it is erased); `403` when the key belongs to one customer workspace (it cannot act as another); `400` when your workspace is not a developer workspace. `/customers/*` and `GET /customers/usage` are your own workspace's and refuse the header with `400`: call them without it.","uniqueKey":"","typeLabel":"string"}},"e026b685-d6b3-4921-9af6-d8af7c00b8ae":{"name":"id","in":"path","required":true,"description":"The agent's id (`ag_…`), as List Agents returns it. Another workspace's agent is the same `404` as one that never existed.","schema":{"type":"string","isRequired":true,"description":"The agent's id (`ag_…`), as List Agents returns it. Another workspace's agent is the same `404` as one that never existed.","uniqueKey":"","typeLabel":"string"},"example":"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"Any subset of the agent's fields. At least one must be a field this API knows.","properties":{"name":{"type":"string","minLength":2,"maxLength":60,"description":"The agent's name, 2 to 60 characters, without hidden characters or markup.","uniqueKey":"name","typeLabel":"string"},"instructions":{"type":"string","maxLength":20000,"description":"What the agent is and how it behaves. Re-sent on every reply, so every character costs on every turn.","uniqueKey":"instructions","typeLabel":"string"},"greeting":{"type":"string","maxLength":200,"description":"The first thing it says on a call or in a chat. An empty string clears it.","uniqueKey":"greeting","typeLabel":"string"},"businessDescription":{"type":"string","maxLength":200,"description":"One line about what the business is. Facts belong in Knowledge.","uniqueKey":"businessDescription","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"A model id from List Models, or `null` to put the agent back on the default model (Prana [Voice]) — the way back to the defaults; the plan and call rules below still apply to it. An empty string is a 400. Checked only when it changes, against the console's one model picker for chat and calls alike: on your plan, quick enough to answer a call (`voice: true`), within the per-minute budget a call can carry, and not one of our voice-only models. A chat-only agent is held to the same list, as in the console.","uniqueKey":"model.oneOf.0","typeLabel":"string"},{"type":"null","description":"A model id from List Models, or `null` to put the agent back on the default model (Prana [Voice]) — the way back to the defaults; the plan and call rules below still apply to it. An empty string is a 400. Checked only when it changes, against the console's one model picker for chat and calls alike: on your plan, quick enough to answer a call (`voice: true`), within the per-minute budget a call can carry, and not one of our voice-only models. A chat-only agent is held to the same list, as in the console.","uniqueKey":"model.oneOf.1","typeLabel":"null"}],"uniqueKey":"model","typeLabel":"string | null"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"How adventurous the wording is. Clamped to 0–2.","uniqueKey":"temperature","typeLabel":"number"},"maxReplyTokens":{"type":"number","minimum":100,"maximum":800,"description":"The longest a reply may be, in tokens, for chat and calls alike. Rounded and clamped to 100–800.","uniqueKey":"maxReplyTokens","typeLabel":"number"},"languages":{"type":"array","maxItems":4,"uniqueItems":true,"items":{"type":"string","uniqueKey":"languages.items.[INDEX]","typeLabel":"string"},"description":"The languages the agent speaks, by their English names: `[]` is auto (reply in the customer's language), one name is that language alone, and two to four make the agent expect those languages, the first being the one it falls back to when it cannot tell. On a phone call the recogniser works out the language among them. Send `languages` or `language`, not both: `language` sets one language and clears this list. A name the console does not offer, a repeat, or more than four is refused with a 400.","uniqueKey":"languages","typeLabel":"string[]"},"language":{"type":"string","description":"`auto` to reply in the customer's language, or a language the console offers by its English name, e.g. `Hindi`, `Tamil`, `English`.","uniqueKey":"language","typeLabel":"string"},"secondLanguage":{"oneOf":[{"type":"string","description":"Retired. Accepted so an older integration keeps working, but ignored: the agent answers in `language` alone.","deprecated":true,"uniqueKey":"secondLanguage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Retired. Accepted so an older integration keeps working, but ignored: the agent answers in `language` alone.","deprecated":true,"uniqueKey":"secondLanguage.oneOf.1","typeLabel":"null"}],"uniqueKey":"secondLanguage","typeLabel":"string | null"},"escalation":{"type":"object","description":"When the agent hands over to a person. Send either or both.","properties":{"onNoAnswer":{"type":"boolean","description":"Hand over when it cannot answer.","uniqueKey":"escalation.onNoAnswer","typeLabel":"boolean"},"onRequest":{"type":"boolean","description":"Hand over when the customer asks for a person.","uniqueKey":"escalation.onRequest","typeLabel":"boolean"}},"example":{"onNoAnswer":false,"onRequest":true},"uniqueKey":"escalation","typeLabel":"object"},"captureLeads":{"type":"boolean","description":"Take a name, email or phone number from an interested customer.","uniqueKey":"captureLeads","typeLabel":"boolean"},"ownRules":{"type":"boolean","description":"true leaves out the platform's own lead, hand-over and call-back sentences, for a business that writes those rules in its instructions. Left out: the sentence about asking for details (or that the business does not collect them), the hand-over rule (or that nobody can be handed to, and that nobody should promise a follow-up) and the \"cannot book a call back\" sentence. Kept whatever you send: the boundary, the AI disclosure, the reply language, the date, your own instructions, and how a call is put through to a person.","uniqueKey":"ownRules","typeLabel":"boolean"},"scheduleCallbacks":{"type":"boolean","description":"Allow it to book a call back when asked.","uniqueKey":"scheduleCallbacks","typeLabel":"boolean"},"welcomeScreen":{"type":"boolean","description":"Open the website widget on a welcome screen.","uniqueKey":"welcomeScreen","typeLabel":"boolean"},"welcomeCollectLeads":{"type":"boolean","description":"Ask for the visitor's details on the welcome screen.","uniqueKey":"welcomeCollectLeads","typeLabel":"boolean"},"steps":{"type":"array","maxItems":12,"description":"The conversation script, in order, replacing the whole script. `[]` removes it.","items":{"type":"object","description":"One step of the script. A step with neither a title nor a detail is dropped.","properties":{"title":{"type":"string","description":"What the step is for. Trimmed and cut to 80 characters.","uniqueKey":"steps.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"What the agent should do here. Trimmed and cut to 600 characters.","uniqueKey":"steps.items.[INDEX].detail","typeLabel":"string"},"branches":{"type":"array","description":"Conditions within the step, e.g. when `If they are already a customer`, action `skip to payment`. A branch missing either half is dropped. Returned in `steps` as written.","items":{"type":"object","properties":{"when":{"type":"string","description":"The condition.","uniqueKey":"steps.items.[INDEX].branches.items.[INDEX].when","typeLabel":"string"},"action":{"type":"string","description":"What to do when it holds.","uniqueKey":"steps.items.[INDEX].branches.items.[INDEX].action","typeLabel":"string"}},"uniqueKey":"steps.items.[INDEX].branches.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps.items.[INDEX].branches","typeLabel":"object[]"},"collect":{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].collect.items.[INDEX]","typeLabel":"string"},"description":"What must be in hand before the step is done — a name, a date, an order number. Returned in `steps`.","uniqueKey":"steps.items.[INDEX].collect","typeLabel":"string[]"}},"example":{"title":"Budget and size","detail":"Ask for their budget and whether they want a 2 BHK or a 3 BHK.","collect":["budget"]},"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"uniqueKey":"steps","typeLabel":"object[]"},"byok":{"oneOf":[{"type":"string","enum":["workspace","off","all","voice","llm","llm_voice",null],"description":"How this agent uses the workspace's own provider keys (Bring your own keys). `null` (or `workspace`) follows the workspace: its default scope applies when it brings its own keys. `off` never does: our voices and models at our normal pricing, whatever the workspace does, and the model is not held to the voice-only-BYOK model list. `all`, `voice`, `llm` or `llm_voice` runs this agent on that scope's keys whatever the workspace default is; refused with `409` naming the missing key unless the workspace holds verified keys for every kind that scope needs. If a key goes later, the agent falls back to the workspace's scope at the next call. Omit the field to leave it unchanged; saved BYOK model and voice choices are kept but not used while it is `off`. Read back as `workspace` when it follows the workspace.","uniqueKey":"byok.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["workspace","off","all","voice","llm","llm_voice",null],"description":"How this agent uses the workspace's own provider keys (Bring your own keys). `null` (or `workspace`) follows the workspace: its default scope applies when it brings its own keys. `off` never does: our voices and models at our normal pricing, whatever the workspace does, and the model is not held to the voice-only-BYOK model list. `all`, `voice`, `llm` or `llm_voice` runs this agent on that scope's keys whatever the workspace default is; refused with `409` naming the missing key unless the workspace holds verified keys for every kind that scope needs. If a key goes later, the agent falls back to the workspace's scope at the next call. Omit the field to leave it unchanged; saved BYOK model and voice choices are kept but not used while it is `off`. Read back as `workspace` when it follows the workspace.","uniqueKey":"byok.oneOf.1","typeLabel":"null"}],"uniqueKey":"byok","typeLabel":"enum\u003cstring> | null"},"widget":{"type":"object","description":"The website widget's look. Send any subset.","properties":{"theme":{"type":"string","enum":["classic","modern"],"description":"The widget's design. Anything else is refused with a 400.","uniqueKey":"widget.theme","typeLabel":"enum\u003cstring>"},"accent":{"oneOf":[{"type":"string","description":"A colour as `#rrggbb` or `#rgb` (the `#` optional). Null or an empty string clears it to the default; anything else that is not a colour is refused with a 400.","uniqueKey":"widget.accent.oneOf.0","typeLabel":"string"},{"type":"null","description":"A colour as `#rrggbb` or `#rgb` (the `#` optional). Null or an empty string clears it to the default; anything else that is not a colour is refused with a 400.","uniqueKey":"widget.accent.oneOf.1","typeLabel":"null"}],"uniqueKey":"widget.accent","typeLabel":"string | null"},"welcomeScreen":{"type":"boolean","description":"Open the widget on a welcome screen — here, where it is returned, or top-level as before.","uniqueKey":"widget.welcomeScreen","typeLabel":"boolean"},"welcomeCollectLeads":{"type":"boolean","description":"Ask for the visitor's details on the welcome screen — here or top-level.","uniqueKey":"widget.welcomeCollectLeads","typeLabel":"boolean"},"height":{"type":"number","minimum":420,"maximum":900,"description":"The open widget's height in pixels, clamped to 420–900.","uniqueKey":"widget.height","typeLabel":"number"}},"example":{"theme":"modern","accent":"#0f766e","height":720},"uniqueKey":"widget","typeLabel":"object"},"voice":{"type":"object","description":"How the agent handles calls. Send any subset. Where an agent has no voice channel yet, sending any of these creates one — switched OFF, so setting only a voice or a message never starts it taking calls; send `answersCalls: true` to switch it on.","properties":{"answersCalls":{"type":"boolean","description":"Whether the agent takes calls at all.","uniqueKey":"voice.answersCalls","typeLabel":"boolean"},"voice":{"oneOf":[{"type":"string","description":"A voice id from List Voices. A Studio voice needs the Pro plan or above. `null` puts the agent back on the default voice a new agent starts with (currently Kavya, a Premium voice, which bills at the Premium rate) — the way back to the defaults. An empty string is refused with a 400.","uniqueKey":"voice.voice.oneOf.0","typeLabel":"string"},{"type":"null","description":"A voice id from List Voices. A Studio voice needs the Pro plan or above. `null` puts the agent back on the default voice a new agent starts with (currently Kavya, a Premium voice, which bills at the Premium rate) — the way back to the defaults. An empty string is refused with a 400.","uniqueKey":"voice.voice.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.voice","typeLabel":"string | null"},"language":{"oneOf":[{"type":"string","maxLength":40,"description":"The language for calls: one the console offers, by its English name (`Hindi`) or its tag (`hi-IN`), or null to follow the agent's `language`. Anything else, `auto` included, is refused with a 400.","uniqueKey":"voice.language.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":40,"description":"The language for calls: one the console offers, by its English name (`Hindi`) or its tag (`hi-IN`), or null to follow the agent's `language`. Anything else, `auto` included, is refused with a 400.","uniqueKey":"voice.language.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.language","typeLabel":"string | null"},"summariseCalls":{"type":"boolean","description":"Write a summary after every call (a small charge per call).","uniqueKey":"voice.summariseCalls","typeLabel":"boolean"},"detectMachines":{"type":"boolean","description":"Hang up on an answering machine.","uniqueKey":"voice.detectMachines","typeLabel":"boolean"},"recordCalls":{"type":"boolean","description":"Record calls.","uniqueKey":"voice.recordCalls","typeLabel":"boolean"},"recordDoNotCall":{"type":"boolean","default":true,"description":"Let the agent add a caller to your do-not-call list when they ask not to be called again. On by default; `false` takes the ability away from this agent, and numbers you add yourself (API, Contacts page) are unaffected. In the console: Voice page, Do-not-call list.","uniqueKey":"voice.recordDoNotCall","typeLabel":"boolean"},"maxCallSeconds":{"oneOf":[{"type":"integer","minimum":60,"maximum":1200,"description":"The longest a call may run, in whole seconds; null for the default ceiling of 20 minutes.","uniqueKey":"voice.maxCallSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":60,"maximum":1200,"description":"The longest a call may run, in whole seconds; null for the default ceiling of 20 minutes.","uniqueKey":"voice.maxCallSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.maxCallSeconds","typeLabel":"integer | null"},"ringSeconds":{"oneOf":[{"type":"integer","minimum":10,"maximum":60,"description":"How long a call the agent places (API calls, campaigns, callbacks, test calls) rings before it is given up, in whole seconds (10 to 60); `null` for the default of 30. In the console: Voice page, Ring time. A call nobody answers in that time ends as `no_answer` (the `hangup` of `call.completed`), and a campaign retries it as one. Can be set per call on Place Call.","uniqueKey":"voice.ringSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":10,"maximum":60,"description":"How long a call the agent places (API calls, campaigns, callbacks, test calls) rings before it is given up, in whole seconds (10 to 60); `null` for the default of 30. In the console: Voice page, Ring time. A call nobody answers in that time ends as `no_answer` (the `hangup` of `call.completed`), and a campaign retries it as one. Can be set per call on Place Call.","uniqueKey":"voice.ringSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.ringSeconds","typeLabel":"integer | null"},"pastConversations":{"type":"string","enum":["fresh","quiet","recap"],"description":"What a call does with earlier conversations: `quiet` (the default) uses them without mentioning it, `recap` opens by recapping them and asking whether to carry on, `fresh` uses nothing from before.","uniqueKey":"voice.pastConversations","typeLabel":"enum\u003cstring>"},"unavailableMessage":{"oneOf":[{"type":"string","maxLength":300,"description":"What a caller hears when this agent's line is switched off (`answersCalls` false), instead of the standard \"not taking calls\" sentence. Trimmed, control characters removed, 300 characters at most (longer is a 400, not a cut); null or blank clears it. Phone calls only. Spoken on Plivo numbers (English, or English in Roman letters, but not Hindi) and on Twilio numbers (English and Hindi); a Vobiz number gets no message (the call is declined as before), a Telnyx number a busy tone and WhatsApp calling a rejection. It is read by the provider's own Indian-English voice, so a message in any other script, or Hindi on Plivo, plays the standard sentence instead. The message is kept either way, and `unavailableMessageNote` says when it will not be spoken as written. Never used for a call refused over a plan, a balance or busy lines.","uniqueKey":"voice.unavailableMessage.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":300,"description":"What a caller hears when this agent's line is switched off (`answersCalls` false), instead of the standard \"not taking calls\" sentence. Trimmed, control characters removed, 300 characters at most (longer is a 400, not a cut); null or blank clears it. Phone calls only. Spoken on Plivo numbers (English, or English in Roman letters, but not Hindi) and on Twilio numbers (English and Hindi); a Vobiz number gets no message (the call is declined as before), a Telnyx number a busy tone and WhatsApp calling a rejection. It is read by the provider's own Indian-English voice, so a message in any other script, or Hindi on Plivo, plays the standard sentence instead. The message is kept either way, and `unavailableMessageNote` says when it will not be spoken as written. Never used for a call refused over a plan, a balance or busy lines.","uniqueKey":"voice.unavailableMessage.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.unavailableMessage","typeLabel":"string | null"},"callStartUrl":{"oneOf":[{"type":"string","maxLength":500,"format":"uri","description":"A call-start lookup: an https address of yours, asked who is calling when an inbound phone or WhatsApp call is about to be answered by the agent (not one forwarded to a person), before the agent speaks. We POST `{ \"event\": \"call.started\", \"callId\", \"surface\": \"phone\" | \"whatsapp\", \"agentId\", \"from\", \"to\", \"direction\": \"inbound\", \"contact\", \"sentAt\" }` — `to` is the agent's voice line (also on a WhatsApp call), and `contact` is the contact you hold under the caller's number (`id`, `name`, `phone`, `email`, `externalId`) or null — signed like a webhook (`x-thinnest-signature`, and `x-thinnest-signature-v2` over `\u003cx-thinnest-delivered-at>.\u003cbody>`) with the secret returned once as `voice.callStartSecret`. Answer within 2 seconds with `{ \"variables\": { \"name\": \"Asha\", \"plan\": \"Gold\" } }`: up to 20, names normalised and values cut to 150 characters as for Place Call's `variables`, strings, numbers and booleans only. They fill `{{...}}` placeholders in the greeting and instructions, over the contact's own fields (yours win). No answer in 2 seconds, a non-2xx status or anything else, and the call goes ahead without them; we never retry it, but the phone provider asks again if it did not get our answer in time, and that repeats the request with the same `callId`, so dedupe on `callId`. Must be https, not a private address, and carry no username or password. `null` or an empty string switches it off and deletes the secret; a new address creates a new secret. Refused with `503` `signing_unavailable` while call-start requests cannot be signed (try again later).","uniqueKey":"voice.callStartUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","maxLength":500,"format":"uri","description":"A call-start lookup: an https address of yours, asked who is calling when an inbound phone or WhatsApp call is about to be answered by the agent (not one forwarded to a person), before the agent speaks. We POST `{ \"event\": \"call.started\", \"callId\", \"surface\": \"phone\" | \"whatsapp\", \"agentId\", \"from\", \"to\", \"direction\": \"inbound\", \"contact\", \"sentAt\" }` — `to` is the agent's voice line (also on a WhatsApp call), and `contact` is the contact you hold under the caller's number (`id`, `name`, `phone`, `email`, `externalId`) or null — signed like a webhook (`x-thinnest-signature`, and `x-thinnest-signature-v2` over `\u003cx-thinnest-delivered-at>.\u003cbody>`) with the secret returned once as `voice.callStartSecret`. Answer within 2 seconds with `{ \"variables\": { \"name\": \"Asha\", \"plan\": \"Gold\" } }`: up to 20, names normalised and values cut to 150 characters as for Place Call's `variables`, strings, numbers and booleans only. They fill `{{...}}` placeholders in the greeting and instructions, over the contact's own fields (yours win). No answer in 2 seconds, a non-2xx status or anything else, and the call goes ahead without them; we never retry it, but the phone provider asks again if it did not get our answer in time, and that repeats the request with the same `callId`, so dedupe on `callId`. Must be https, not a private address, and carry no username or password. `null` or an empty string switches it off and deletes the secret; a new address creates a new secret. Refused with `503` `signing_unavailable` while call-start requests cannot be signed (try again later).","uniqueKey":"voice.callStartUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.callStartUrl","typeLabel":"string\u003curi> | null"},"callStartSecret":{"type":"string","enum":["rotate"],"description":"Send `\"rotate\"` to create a new signing secret for the existing `callStartUrl` (or the one in the same request); the old one stops working at once. The new secret comes back once, as `voice.callStartSecret` on the response. Needs a `callStartUrl`. You cannot choose the secret yourself.","uniqueKey":"voice.callStartSecret","typeLabel":"enum\u003cstring>"},"surfaces":{"type":"array","items":{"type":"string","enum":["phone","web","whatsapp"],"uniqueKey":"voice.surfaces.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueItems":true,"description":"Where the agent answers calls: `web` (the call button on your website), `whatsapp` (WhatsApp calls; whether a WhatsApp number takes calls is its own Calls switch on Connect WhatsApp), `phone` (its phone number). A new agent starts with `[\"web\", \"whatsapp\"]`, and `phone` is added when a number is attached. Adding `phone` while the agent answers calls (`answersCalls` true) and has no number to answer or call from is refused with `409` `phone_number_required`; with calls off you may set it first and attach a number after. On a plan that cannot hold a number, `phone` is left out. While a number is attached, `phone` stays on even if you leave it out (a number nobody answers is a caller hearing silence): to stop the phone ringing, send `answersCalls: false` or take the number off. Anything other than these three values is a 400.","example":["web","phone"],"uniqueKey":"voice.surfaces","typeLabel":"enum\u003cstring>[]"},"thinking":{"type":"boolean","default":true,"description":"Say a short filler (\"One moment.\") when a reply has not started after `thinkingDelayMs`, for example while an action runs.","uniqueKey":"voice.thinking","typeLabel":"boolean"},"thinkingLines":{"oneOf":[{"type":"array","maxItems":8,"items":{"type":"string","maxLength":60,"uniqueKey":"voice.thinkingLines.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Your own filler lines, one phrase per item: up to 8, each 60 characters or fewer after trimming (blank items are dropped; a line break inside an item is a 400). Longer or more is refused with a 400, never cut. Each call uses the lines written in the caller's script (Hindi lines on a Hindi call, English on an English one). Words of an Indian language typed in Roman letters are converted to that language's script when saved. `null` or `[]` goes back to the built-in fillers in the caller's language.","example":["One moment, let me check.","Just a second."],"uniqueKey":"voice.thinkingLines.oneOf.0","typeLabel":"string[]"},{"type":"null","maxItems":8,"items":{"type":"string","maxLength":60},"description":"Your own filler lines, one phrase per item: up to 8, each 60 characters or fewer after trimming (blank items are dropped; a line break inside an item is a 400). Longer or more is refused with a 400, never cut. Each call uses the lines written in the caller's script (Hindi lines on a Hindi call, English on an English one). Words of an Indian language typed in Roman letters are converted to that language's script when saved. `null` or `[]` goes back to the built-in fillers in the caller's language.","example":["One moment, let me check.","Just a second."],"uniqueKey":"voice.thinkingLines.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.thinkingLines","typeLabel":"string[] | null"},"thinkingDelayMs":{"oneOf":[{"type":"integer","minimum":200,"maximum":5000,"default":900,"description":"Milliseconds of quiet before the filler is said, 200 to 5000. `null` goes back to 900.","uniqueKey":"voice.thinkingDelayMs.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":200,"maximum":5000,"default":900,"description":"Milliseconds of quiet before the filler is said, 200 to 5000. `null` goes back to 900.","uniqueKey":"voice.thinkingDelayMs.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.thinkingDelayMs","typeLabel":"integer | null"},"thinkingRepeatMs":{"oneOf":[{"type":"integer","minimum":1000,"maximum":10000,"default":2500,"description":"Milliseconds after one filler before another may be said (and how often a long-running action is covered again), 1000 to 10000. `null` goes back to 2500.","uniqueKey":"voice.thinkingRepeatMs.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1000,"maximum":10000,"default":2500,"description":"Milliseconds after one filler before another may be said (and how often a long-running action is covered again), 1000 to 10000. `null` goes back to 2500.","uniqueKey":"voice.thinkingRepeatMs.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.thinkingRepeatMs","typeLabel":"integer | null"},"thinkingAtTurnEnd":{"type":"boolean","default":false,"description":"Always acknowledge (\"Okay.\") the moment the caller stops, before every reply, instead of only when a reply is slow. Suits a slow model; on a quick one it is a syllable in front of everything.","uniqueKey":"voice.thinkingAtTurnEnd","typeLabel":"boolean"},"turnDetection":{"oneOf":[{"type":"string","enum":["smart","timer","timer_v2","ear",null],"description":"How the agent decides the caller has finished speaking. `smart`: a model predicts whether the sentence is finished, so a caller who pauses to think is not cut off, but replies start later; `turnSilenceSeconds` is then a ceiling on how long it keeps waiting (0.6 s unless set). `timer`: a stretch of silence ends the turn, which is faster but cuts off people who pause mid-sentence; `turnSilenceSeconds` is that silence (0.25 s unless set). `timer_v2`: like `timer`, but at each pause an AI check reads what the caller said and decides whether they have finished, so a pause mid-sentence is not answered as if they were done; words said over the agent are judged the same way (a listener's \"haan ji\" lets it carry on, a clear interruption stops it); `turnSilenceSeconds` is not used. `ear`: real-time speech recognition decides when the caller has finished, and can stop the agent while the caller is still speaking; the agent uses `timer` on a line where real-time recognition is not available. `null` follows the platform's own setting (the Voice page shows which). Anything else is a 400.","uniqueKey":"voice.turnDetection.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["smart","timer","timer_v2","ear",null],"description":"How the agent decides the caller has finished speaking. `smart`: a model predicts whether the sentence is finished, so a caller who pauses to think is not cut off, but replies start later; `turnSilenceSeconds` is then a ceiling on how long it keeps waiting (0.6 s unless set). `timer`: a stretch of silence ends the turn, which is faster but cuts off people who pause mid-sentence; `turnSilenceSeconds` is that silence (0.25 s unless set). `timer_v2`: like `timer`, but at each pause an AI check reads what the caller said and decides whether they have finished, so a pause mid-sentence is not answered as if they were done; words said over the agent are judged the same way (a listener's \"haan ji\" lets it carry on, a clear interruption stops it); `turnSilenceSeconds` is not used. `ear`: real-time speech recognition decides when the caller has finished, and can stop the agent while the caller is still speaking; the agent uses `timer` on a line where real-time recognition is not available. `null` follows the platform's own setting (the Voice page shows which). Anything else is a 400.","uniqueKey":"voice.turnDetection.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.turnDetection","typeLabel":"enum\u003cstring> | null"},"turnSilenceSeconds":{"oneOf":[{"type":"number","minimum":0.2,"maximum":3,"description":"Seconds of quiet, 0.2 to 3. With `turnDetection` `timer` it is the silence that ends the caller's turn (0.25 s unless set); with `smart` it is a ceiling on how long the model may keep waiting (0.6 s unless set). `null` goes back to the default. Shorter answers sooner and cuts slow speakers off more often.","uniqueKey":"voice.turnSilenceSeconds.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.2,"maximum":3,"description":"Seconds of quiet, 0.2 to 3. With `turnDetection` `timer` it is the silence that ends the caller's turn (0.25 s unless set); with `smart` it is a ceiling on how long the model may keep waiting (0.6 s unless set). `null` goes back to the default. Shorter answers sooner and cuts slow speakers off more often.","uniqueKey":"voice.turnSilenceSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.turnSilenceSeconds","typeLabel":"number | null"},"reaskAfterSeconds":{"oneOf":[{"type":"number","description":"How long to wait, after a question the agent asked has had no answer, before it asks again. `0` means never ask again; otherwise 1.5 to 10 seconds (one decimal). `null` goes back to the platform's 2.5 seconds.","uniqueKey":"voice.reaskAfterSeconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"How long to wait, after a question the agent asked has had no answer, before it asks again. `0` means never ask again; otherwise 1.5 to 10 seconds (one decimal). `null` goes back to the platform's 2.5 seconds.","uniqueKey":"voice.reaskAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.reaskAfterSeconds","typeLabel":"number | null"},"interruptWords":{"oneOf":[{"type":"integer","minimum":1,"maximum":6,"default":3,"description":"How many words a caller must say to cut the agent off while it is speaking, 1 to 6. Short acknowledgements (\"okay\", \"haan\") under this never interrupt. `null` goes back to 3.","uniqueKey":"voice.interruptWords.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":6,"default":3,"description":"How many words a caller must say to cut the agent off while it is speaking, 1 to 6. Short acknowledgements (\"okay\", \"haan\") under this never interrupt. `null` goes back to 3.","uniqueKey":"voice.interruptWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.interruptWords","typeLabel":"integer | null"},"neverInterrupt":{"type":"boolean","default":false,"description":"The agent can never be cut off, on any line, at any length — for a disclosure or a price read out in full. What the caller says meanwhile is handled by `holdShortSpeech`.","uniqueKey":"voice.neverInterrupt","typeLabel":"boolean"},"realtimeVoice":{"oneOf":[{"type":"string","description":"Only for an agent on a realtime model (OpenAI GPT-Live-1 or OpenAI GPT-Realtime Mini): one of that model's own voices, from `voices` on its entry in List Models. null is its default. The agent's `voice` is kept as it is, for when it goes back to another model. Realtime models are on the Enterprise plan only for now: we set them up on your agents, they are not in List Models, and `model` refuses one as a new choice.","uniqueKey":"voice.realtimeVoice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Only for an agent on a realtime model (OpenAI GPT-Live-1 or OpenAI GPT-Realtime Mini): one of that model's own voices, from `voices` on its entry in List Models. null is its default. The agent's `voice` is kept as it is, for when it goes back to another model. Realtime models are on the Enterprise plan only for now: we set them up on your agents, they are not in List Models, and `model` refuses one as a new choice.","uniqueKey":"voice.realtimeVoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeVoice","typeLabel":"string | null"},"realtimeSession":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Only for an agent on OpenAI GPT-Realtime Mini: its session settings. Send only the fields you change; the rest keep their values. null puts them all back to the defaults. A value outside its range is brought into it; a wrong type or an unknown field is refused, naming it.","properties":{"noiseReduction":{"type":"string","enum":["auto","near_field","far_field","off"],"description":"Cleans the caller's audio first. `auto`: near_field on phone calls, far_field on web calls. Default auto.","uniqueKey":"voice.realtimeSession.oneOf.0.noiseReduction","typeLabel":"enum\u003cstring>"},"turnDetection":{"type":"string","enum":["server_vad","semantic_vad"],"description":"How it knows the caller has finished: `server_vad` by silence, `semantic_vad` by meaning. Default server_vad.","uniqueKey":"voice.realtimeSession.oneOf.0.turnDetection","typeLabel":"enum\u003cstring>"},"vadThreshold":{"type":"number","minimum":0,"maximum":1,"description":"By silence: how loud speech must be to count. Default 0.5.","uniqueKey":"voice.realtimeSession.oneOf.0.vadThreshold","typeLabel":"number"},"prefixPaddingMs":{"type":"number","minimum":0,"maximum":1000,"description":"By silence: audio kept from just before speech starts, ms. Default 300.","uniqueKey":"voice.realtimeSession.oneOf.0.prefixPaddingMs","typeLabel":"number"},"silenceDurationMs":{"type":"number","minimum":200,"maximum":2000,"description":"By silence: the quiet that ends the caller's turn, ms. Default 500.","uniqueKey":"voice.realtimeSession.oneOf.0.silenceDurationMs","typeLabel":"number"},"idleTimeoutMs":{"oneOf":[{"type":"number","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call.","uniqueKey":"voice.realtimeSession.oneOf.0.idleTimeoutMs.oneOf.0","typeLabel":"number"},{"type":"null","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call.","uniqueKey":"voice.realtimeSession.oneOf.0.idleTimeoutMs.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeSession.oneOf.0.idleTimeoutMs","typeLabel":"number | null"},"eagerness":{"type":"string","enum":["auto","low","medium","high"],"description":"By meaning: how soon it decides the caller has finished. Default auto.","uniqueKey":"voice.realtimeSession.oneOf.0.eagerness","typeLabel":"enum\u003cstring>"},"interruptResponse":{"type":"boolean","description":"Whether a caller speaking cuts the agent off. Default true.","uniqueKey":"voice.realtimeSession.oneOf.0.interruptResponse","typeLabel":"boolean"},"transcriptionModel":{"type":"string","enum":["gpt-4o-mini-transcribe","gpt-4o-transcribe","whisper-1"],"description":"The caller's transcript: fast (the default), most accurate, or classic.","uniqueKey":"voice.realtimeSession.oneOf.0.transcriptionModel","typeLabel":"enum\u003cstring>"},"transcriptionPrompt":{"oneOf":[{"type":"string","maxLength":500,"description":"Names and brand words the transcript should get right; null is none.","uniqueKey":"voice.realtimeSession.oneOf.0.transcriptionPrompt.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":500,"description":"Names and brand words the transcript should get right; null is none.","uniqueKey":"voice.realtimeSession.oneOf.0.transcriptionPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeSession.oneOf.0.transcriptionPrompt","typeLabel":"string | null"},"maxOutputTokens":{"oneOf":[{"type":"number","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default).","uniqueKey":"voice.realtimeSession.oneOf.0.maxOutputTokens.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default).","uniqueKey":"voice.realtimeSession.oneOf.0.maxOutputTokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeSession.oneOf.0.maxOutputTokens","typeLabel":"number | null"},"speed":{"type":"number","minimum":0.25,"maximum":1.5,"description":"Speaking speed. Default 1.","uniqueKey":"voice.realtimeSession.oneOf.0.speed","typeLabel":"number"},"truncationRetention":{"oneOf":[{"type":"number","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default).","uniqueKey":"voice.realtimeSession.oneOf.0.truncationRetention.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default).","uniqueKey":"voice.realtimeSession.oneOf.0.truncationRetention.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeSession.oneOf.0.truncationRetention","typeLabel":"number | null"}},"uniqueKey":"voice.realtimeSession.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Only for an agent on OpenAI GPT-Realtime Mini: its session settings. Send only the fields you change; the rest keep their values. null puts them all back to the defaults. A value outside its range is brought into it; a wrong type or an unknown field is refused, naming it.","properties":{"noiseReduction":{"type":"string","enum":["auto","near_field","far_field","off"],"description":"Cleans the caller's audio first. `auto`: near_field on phone calls, far_field on web calls. Default auto."},"turnDetection":{"type":"string","enum":["server_vad","semantic_vad"],"description":"How it knows the caller has finished: `server_vad` by silence, `semantic_vad` by meaning. Default server_vad."},"vadThreshold":{"type":"number","minimum":0,"maximum":1,"description":"By silence: how loud speech must be to count. Default 0.5."},"prefixPaddingMs":{"type":"number","minimum":0,"maximum":1000,"description":"By silence: audio kept from just before speech starts, ms. Default 300."},"silenceDurationMs":{"type":"number","minimum":200,"maximum":2000,"description":"By silence: the quiet that ends the caller's turn, ms. Default 500."},"idleTimeoutMs":{"oneOf":[{"type":"number","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call."},{"type":"null","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call."}]},"eagerness":{"type":"string","enum":["auto","low","medium","high"],"description":"By meaning: how soon it decides the caller has finished. Default auto."},"interruptResponse":{"type":"boolean","description":"Whether a caller speaking cuts the agent off. Default true."},"transcriptionModel":{"type":"string","enum":["gpt-4o-mini-transcribe","gpt-4o-transcribe","whisper-1"],"description":"The caller's transcript: fast (the default), most accurate, or classic."},"transcriptionPrompt":{"oneOf":[{"type":"string","maxLength":500,"description":"Names and brand words the transcript should get right; null is none."},{"type":"null","maxLength":500,"description":"Names and brand words the transcript should get right; null is none."}]},"maxOutputTokens":{"oneOf":[{"type":"number","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default)."},{"type":"null","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default)."}]},"speed":{"type":"number","minimum":0.25,"maximum":1.5,"description":"Speaking speed. Default 1."},"truncationRetention":{"oneOf":[{"type":"number","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default)."},{"type":"null","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default)."}]}},"uniqueKey":"voice.realtimeSession.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.realtimeSession","typeLabel":"object | null"},"earlyAnswers":{"type":"boolean","description":"On by default. The agent starts working on its reply the moment it has heard what the caller said, while it is still making sure they have finished, so the first words come sooner. If the caller goes on, that early reply is thrown away and never spoken or recorded, but it still costs the model's tokens: on an agent that runs on your own model key they are billed to your key and are not counted in the call's `usage`. `false` starts a reply only once the caller has finished.","uniqueKey":"voice.earlyAnswers","typeLabel":"boolean"},"holdShortSpeech":{"type":"boolean","default":true,"description":"Keep words the caller says over the agent (too few to interrupt) and answer them when it stops. `false` discards them; if that was all the caller said, the agent finishes and waits.","uniqueKey":"voice.holdShortSpeech","typeLabel":"boolean"},"greetingUninterruptible":{"type":"boolean","default":false,"description":"Let the greeting finish on phone calls even if the caller talks over it (callers often say \"hello\" on pickup). What they said is kept and answered next.","uniqueKey":"voice.greetingUninterruptible","typeLabel":"boolean"},"openingWaitsForCaller":{"type":"boolean","default":false,"description":"Hold the opening line until the person who picked up speaks, then play it right after their first words (a bare \"Hello\" that started it is not answered a second time). If they stay silent it plays after four seconds. Default false: it plays the moment the call connects. Phone calls on a voice agent; not used on a realtime model.","uniqueKey":"voice.openingWaitsForCaller","typeLabel":"boolean"},"openingWaitSeconds":{"oneOf":[{"type":"number","minimum":0.5,"maximum":10,"description":"With `openingWaitsForCaller` on: how many seconds of silence after pickup before the opening plays anyway. 0.5 to 10, a tenth of a second at most. A shorter wait talks over a slow \"Hello\"; a longer one leaves a silent pickup waiting. `null` is the default, 4.","uniqueKey":"voice.openingWaitSeconds.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.5,"maximum":10,"description":"With `openingWaitsForCaller` on: how many seconds of silence after pickup before the opening plays anyway. 0.5 to 10, a tenth of a second at most. A shorter wait talks over a slow \"Hello\"; a longer one leaves a silent pickup waiting. `null` is the default, 4.","uniqueKey":"voice.openingWaitSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.openingWaitSeconds","typeLabel":"number | null"},"ambience":{"oneOf":[{"type":"string","enum":["office","office-quiet",null],"default":null,"description":"A background sound under the call: `office`, `office-quiet`, or `null` for none.","uniqueKey":"voice.ambience.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["office","office-quiet",null],"default":null,"description":"A background sound under the call: `office`, `office-quiet`, or `null` for none.","uniqueKey":"voice.ambience.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.ambience","typeLabel":"enum\u003cstring> | null"},"ambienceVolume":{"oneOf":[{"type":"number","minimum":0.05,"maximum":1,"default":0.15,"description":"The background sound's volume, 0.05 to 1, with at most two decimal places (more is refused with a 400). `null` goes back to 0.15.","uniqueKey":"voice.ambienceVolume.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.05,"maximum":1,"default":0.15,"description":"The background sound's volume, 0.05 to 1, with at most two decimal places (more is refused with a 400). `null` goes back to 0.15.","uniqueKey":"voice.ambienceVolume.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.ambienceVolume","typeLabel":"number | null"},"speakingSpeed":{"oneOf":[{"type":"number","minimum":0.7,"maximum":1.3,"default":1,"description":"How fast the agent talks, as a multiple of the voice's own pace: 0.9 is a little slower, 1.1 a little faster (the console's slider moves in steps of 0.05). Every voice follows it, cloned voices included, and so does a voice from your own voice account wherever that provider has a speed setting (a speed set in a Cartesia voice's own settings is used instead). `null` (or 1) is the voice's own pace.","uniqueKey":"voice.speakingSpeed.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.7,"maximum":1.3,"default":1,"description":"How fast the agent talks, as a multiple of the voice's own pace: 0.9 is a little slower, 1.1 a little faster (the console's slider moves in steps of 0.05). Every voice follows it, cloned voices included, and so does a voice from your own voice account wherever that provider has a speed setting (a speed set in a Cartesia voice's own settings is used instead). `null` (or 1) is the voice's own pace.","uniqueKey":"voice.speakingSpeed.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.speakingSpeed","typeLabel":"number | null"},"backchannelDetection":{"type":"boolean","default":true,"description":"Ear mode only. Tell a caller's backchannel (\"haan ji\", \"okay\", \"mm-hmm\") from a real interruption while the agent is talking. Off: only `interruptWords` decides.","uniqueKey":"voice.backchannelDetection","typeLabel":"boolean"},"backchannelWords":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"uniqueKey":"voice.backchannelWords.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":30,"description":"Ear mode only. Caller backchannel words that always mean \"I am listening\", on top of what the agent recognises. `null` or `[]` is the agent's own judgement alone.","uniqueKey":"voice.backchannelWords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":40},"maxItems":30,"description":"Ear mode only. Caller backchannel words that always mean \"I am listening\", on top of what the agent recognises. `null` or `[]` is the agent's own judgement alone.","uniqueKey":"voice.backchannelWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.backchannelWords","typeLabel":"string[] | null"},"acknowledgements":{"type":"boolean","default":true,"description":"Ear mode only. The agent speaks a short backchannel / acknowledgement when the caller pauses mid-explanation. Off: it waits silently.","uniqueKey":"voice.acknowledgements","typeLabel":"boolean"},"acknowledgementWords":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":40,"uniqueKey":"voice.acknowledgementWords.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":30,"description":"Ear mode only. The agent's backchannel phrases, said in turn. `null` or `[]` is a short word in the caller's own language.","uniqueKey":"voice.acknowledgementWords.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":40},"maxItems":30,"description":"Ear mode only. The agent's backchannel phrases, said in turn. `null` or `[]` is a short word in the caller's own language.","uniqueKey":"voice.acknowledgementWords.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.acknowledgementWords","typeLabel":"string[] | null"},"vocabulary":{"oneOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":64,"uniqueKey":"voice.vocabulary.oneOf.0.items.[INDEX]","typeLabel":"string"},"maxItems":50,"description":"Names and terms the agent should hear correctly on calls: your products, places, people. Given to the speech recognition as its custom vocabulary. `null` or `[]` is none.","uniqueKey":"voice.vocabulary.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string","minLength":1,"maxLength":64},"maxItems":50,"description":"Names and terms the agent should hear correctly on calls: your products, places, people. Given to the speech recognition as its custom vocabulary. `null` or `[]` is none.","uniqueKey":"voice.vocabulary.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.vocabulary","typeLabel":"string[] | null"},"endCallOnFinish":{"type":"boolean","description":"Release the line when the agent ends the conversation. With it off, the call stays open until the caller hangs up and you are charged for every minute. Agents created in the console or by this API start with it off; an agent made earlier that never had it saved still reads as true.","uniqueKey":"voice.endCallOnFinish","typeLabel":"boolean"},"nudgeAfterSeconds":{"oneOf":[{"type":"integer","minimum":5,"maximum":180,"default":null,"description":"Seconds of caller silence before the agent asks whether they are still there, 5 to 180. `null` never asks.","uniqueKey":"voice.nudgeAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":5,"maximum":180,"default":null,"description":"Seconds of caller silence before the agent asks whether they are still there, 5 to 180. `null` never asks.","uniqueKey":"voice.nudgeAfterSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.nudgeAfterSeconds","typeLabel":"integer | null"},"nudges":{"oneOf":[{"type":"integer","minimum":1,"maximum":5,"default":1,"description":"How many times it asks before giving up, 1 to 5; reset whenever the caller speaks. `null` goes back to 1.","uniqueKey":"voice.nudges.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":5,"default":1,"description":"How many times it asks before giving up, 1 to 5; reset whenever the caller speaks. `null` goes back to 1.","uniqueKey":"voice.nudges.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.nudges","typeLabel":"integer | null"},"nudgePhrase":{"oneOf":[{"type":"string","maxLength":120,"description":"What it asks, 120 characters or fewer (longer is a 400). `null` or blank asks \"Are you still there?\" in the caller's language.","uniqueKey":"voice.nudgePhrase.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":120,"description":"What it asks, 120 characters or fewer (longer is a 400). `null` or blank asks \"Are you still there?\" in the caller's language.","uniqueKey":"voice.nudgePhrase.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.nudgePhrase","typeLabel":"string | null"},"endAfterSilenceSeconds":{"oneOf":[{"type":"integer","minimum":5,"maximum":180,"default":null,"description":"Seconds of caller silence after which the call ends, 5 to 180, or `null`. When the agent also asks (`nudgeAfterSeconds`), this is raised to at least `nudgeAfterSeconds × (nudges + 1)` so every question gets an answer window; with asking on and this null, the call ends when the last question goes unanswered.","uniqueKey":"voice.endAfterSilenceSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":5,"maximum":180,"default":null,"description":"Seconds of caller silence after which the call ends, 5 to 180, or `null`. When the agent also asks (`nudgeAfterSeconds`), this is raised to at least `nudgeAfterSeconds × (nudges + 1)` so every question gets an answer window; with asking on and this null, the call ends when the last question goes unanswered.","uniqueKey":"voice.endAfterSilenceSeconds.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.endAfterSilenceSeconds","typeLabel":"integer | null"},"endPhrases":{"oneOf":[{"type":"array","maxItems":12,"items":{"type":"string","minLength":2,"maxLength":60,"uniqueKey":"voice.endPhrases.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Phrases that end the call when the caller says them: up to 12, each 2 to 60 characters after trimming, and still at least 2 once punctuation is removed (a phrase such as `!!` is refused with a 400 that names it). Matched case-insensitively anywhere in what the caller says, in any language — a short word also matches inside longer ones. Stored lower-case with punctuation removed; duplicates are dropped. `null` or `[]` clears them.","example":["bye","that is all"],"uniqueKey":"voice.endPhrases.oneOf.0","typeLabel":"string[]"},{"type":"null","maxItems":12,"items":{"type":"string","minLength":2,"maxLength":60},"description":"Phrases that end the call when the caller says them: up to 12, each 2 to 60 characters after trimming, and still at least 2 once punctuation is removed (a phrase such as `!!` is refused with a 400 that names it). Matched case-insensitively anywhere in what the caller says, in any language — a short word also matches inside longer ones. Stored lower-case with punctuation removed; duplicates are dropped. `null` or `[]` clears them.","example":["bye","that is all"],"uniqueKey":"voice.endPhrases.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.endPhrases","typeLabel":"string[] | null"},"callInstructions":{"oneOf":[{"type":"string","maxLength":4000,"description":"How the agent should speak on calls (the console's call instructions box), 4000 characters or fewer, separate from the agent's `instructions` limit. It REPLACES the built-in call rules and is added after the agent's instructions in the call prompt. Longer is refused with a 400, never cut. `null` or blank goes back to the built-in rules.","uniqueKey":"voice.callInstructions.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":4000,"description":"How the agent should speak on calls (the console's call instructions box), 4000 characters or fewer, separate from the agent's `instructions` limit. It REPLACES the built-in call rules and is added after the agent's instructions in the call prompt. Longer is refused with a 400, never cut. `null` or blank goes back to the built-in rules.","uniqueKey":"voice.callInstructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.callInstructions","typeLabel":"string | null"}},"example":{"voice":"priya","summariseCalls":true,"maxCallSeconds":300,"pastConversations":"quiet","thinkingLines":["One moment, let me check."],"interruptWords":2,"nudgeAfterSeconds":10,"nudges":2,"endPhrases":["bye"]},"uniqueKey":"voice","typeLabel":"object"},"collectFields":{"oneOf":[{"type":"array","maxItems":30,"description":"The details to fill in after every call, replacing the list. `[]` or null stops collecting; records already taken are kept.","items":{"type":"object","description":"One detail to fill in after every call — the same shape as a call's `extract`.","required":["name"],"properties":{"name":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,59}$","description":"Letters, digits and underscores, starting with a letter, up to 60 characters. Unique, ignoring case.","isRequired":true,"uniqueKey":"collectFields.oneOf.0.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["text","number","integer","boolean","date"],"default":"text","description":"The value's type.","uniqueKey":"collectFields.oneOf.0.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"type":"string","maxLength":200,"description":"What to put in it, as the model reads it.","uniqueKey":"collectFields.oneOf.0.items.[INDEX].description","typeLabel":"string"},"choices":{"type":"array","maxItems":30,"items":{"type":"string","maxLength":60,"uniqueKey":"collectFields.oneOf.0.items.[INDEX].choices.items.[INDEX]","typeLabel":"string"},"description":"Values a `text` field must be one of. Only for `text`.","uniqueKey":"collectFields.oneOf.0.items.[INDEX].choices","typeLabel":"string[]"}},"example":{"name":"interest","type":"text","description":"How keen they sounded","choices":["Hot","Warm","Cold"]},"uniqueKey":"collectFields.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"collectFields.oneOf.0","typeLabel":"object[]"},{"type":"null","maxItems":30,"description":"The details to fill in after every call, replacing the list. `[]` or null stops collecting; records already taken are kept.","items":{"type":"object","description":"One detail to fill in after every call — the same shape as a call's `extract`.","required":["name"],"properties":{"name":{"type":"string","pattern":"^[A-Za-z][A-Za-z0-9_]{0,59}$","description":"Letters, digits and underscores, starting with a letter, up to 60 characters. Unique, ignoring case."},"type":{"type":"string","enum":["text","number","integer","boolean","date"],"default":"text","description":"The value's type."},"description":{"type":"string","maxLength":200,"description":"What to put in it, as the model reads it."},"choices":{"type":"array","maxItems":30,"items":{"type":"string","maxLength":60},"description":"Values a `text` field must be one of. Only for `text`."}},"example":{"name":"interest","type":"text","description":"How keen they sounded","choices":["Hot","Warm","Cold"]}},"uniqueKey":"collectFields.oneOf.1","typeLabel":"null"}],"uniqueKey":"collectFields","typeLabel":"object[] | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"greeting":"Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?","temperature":0.4,"widget":{"accent":"#0f766e"},"voice":{"pastConversations":"recap","detectMachines":true}},"examples":{"Example":{"title":"Example","value":{"greeting":"Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?","temperature":0.4,"widget":{"accent":"#0f766e"},"voice":{"pastConversations":"recap","detectMachines":true}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"371fc438-fa61-45a3-8add-b5729e7e9606":{"description":"The agent after the change.","content":{"application/json":{"schema":{"type":"object","description":"An agent as the console shows it.","required":["id","name","instructions","greeting","businessDescription","model","temperature","maxReplyTokens","language","languages","secondLanguage","escalation","captureLeads","ownRules","scheduleCallbacks","steps","widget","voice","byok","collectFields","webKey","createdAt"],"properties":{"id":{"type":"string","description":"The agent's id.","example":"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"name":{"type":"string","description":"The agent's name, 2 to 60 characters.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"instructions":{"type":"string","description":"What the agent is and how it behaves — its standing prompt.","isRequired":true,"uniqueKey":"instructions","typeLabel":"string"},"greeting":{"type":"string","description":"The first thing it says, or an empty string.","isRequired":true,"uniqueKey":"greeting","typeLabel":"string"},"businessDescription":{"type":"string","description":"One line about the business, or an empty string.","isRequired":true,"uniqueKey":"businessDescription","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"A model id from List Models. `null` when the agent is on a model that has since been retired.","isRequired":true,"uniqueKey":"model.oneOf.0","typeLabel":"string"},{"type":"null","description":"A model id from List Models. `null` when the agent is on a model that has since been retired.","isRequired":true,"uniqueKey":"model.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"model","typeLabel":"string | null"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"How adventurous the wording is.","isRequired":true,"uniqueKey":"temperature","typeLabel":"number"},"maxReplyTokens":{"type":"integer","minimum":100,"maximum":800,"description":"The longest a reply may be, in tokens — one ceiling for chat and calls.","isRequired":true,"uniqueKey":"maxReplyTokens","typeLabel":"integer"},"language":{"type":"string","description":"`auto` (reply in the customer's language) or the language it always replies in, e.g. `Hindi`. When the agent is set to speak several languages this is `auto`: read `languages`.","isRequired":true,"uniqueKey":"language","typeLabel":"string"},"languages":{"type":"array","items":{"type":"string","uniqueKey":"languages.items.[INDEX]","typeLabel":"string"},"description":"The languages the agent speaks, as the console shows them: `[]` is auto, one name is that language alone, and two to four are the languages it expects, the first being the one it falls back to.","isRequired":true,"uniqueKey":"languages","typeLabel":"string[]"},"secondLanguage":{"oneOf":[{"type":"string","description":"Retired — always `null`. An agent answers in one language, `language`. Still returned so a client that reads it keeps working.","deprecated":true,"isRequired":true,"uniqueKey":"secondLanguage.oneOf.0","typeLabel":"string"},{"type":"null","description":"Retired — always `null`. An agent answers in one language, `language`. Still returned so a client that reads it keeps working.","deprecated":true,"isRequired":true,"uniqueKey":"secondLanguage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"secondLanguage","typeLabel":"string | null"},"escalation":{"type":"object","description":"When the agent hands the conversation to a person on your team.","required":["onNoAnswer","onRequest"],"properties":{"onNoAnswer":{"type":"boolean","description":"Hand over when it cannot answer.","isRequired":true,"uniqueKey":"escalation.onNoAnswer","typeLabel":"boolean"},"onRequest":{"type":"boolean","description":"Hand over when the customer asks for a person.","isRequired":true,"uniqueKey":"escalation.onRequest","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"escalation","typeLabel":"object"},"captureLeads":{"type":"boolean","description":"Whether it takes a name, email or phone number from an interested customer.","isRequired":true,"uniqueKey":"captureLeads","typeLabel":"boolean"},"ownRules":{"type":"boolean","description":"true leaves out the platform's own lead, hand-over and call-back sentences, for a business that writes those rules in its instructions. Left out: the sentence about asking for details (or that the business does not collect them), the hand-over rule (or that nobody can be handed to, and that nobody should promise a follow-up) and the \"cannot book a call back\" sentence. Kept whatever you send: the boundary, the AI disclosure, the reply language, the date, your own instructions, and how a call is put through to a person.","isRequired":true,"uniqueKey":"ownRules","typeLabel":"boolean"},"scheduleCallbacks":{"type":"boolean","description":"Whether it may book a call back when asked.","isRequired":true,"uniqueKey":"scheduleCallbacks","typeLabel":"boolean"},"steps":{"type":"array","description":"Its conversation script, in order.","items":{"type":"object","description":"One step of the conversation script.","required":["title","detail","branches","collect"],"properties":{"title":{"type":"string","description":"What the step is for, up to 80 characters.","isRequired":true,"uniqueKey":"steps.items.[INDEX].title","typeLabel":"string"},"detail":{"type":"string","description":"What the agent should do here, up to 600 characters.","isRequired":true,"uniqueKey":"steps.items.[INDEX].detail","typeLabel":"string"},"branches":{"type":"array","description":"Conditions within the step, as written. Empty when it has none.","items":{"type":"object","required":["when","action"],"properties":{"when":{"type":"string","description":"The condition.","isRequired":true,"uniqueKey":"steps.items.[INDEX].branches.items.[INDEX].when","typeLabel":"string"},"action":{"type":"string","description":"What to do when it holds.","isRequired":true,"uniqueKey":"steps.items.[INDEX].branches.items.[INDEX].action","typeLabel":"string"}},"uniqueKey":"steps.items.[INDEX].branches.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps.items.[INDEX].branches","typeLabel":"object[]"},"collect":{"type":"array","items":{"type":"string","uniqueKey":"steps.items.[INDEX].collect.items.[INDEX]","typeLabel":"string"},"description":"What must be in hand before the step is done. Empty when nothing is.","isRequired":true,"uniqueKey":"steps.items.[INDEX].collect","typeLabel":"string[]"}},"uniqueKey":"steps.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"steps","typeLabel":"object[]"},"widget":{"type":"object","description":"The website chat widget's look.","required":["theme","accent","height","welcomeScreen","welcomeCollectLeads"],"properties":{"theme":{"type":"string","enum":["classic","modern"],"description":"The widget's design.","isRequired":true,"uniqueKey":"widget.theme","typeLabel":"enum\u003cstring>"},"accent":{"oneOf":[{"type":"string","description":"The accent colour as `#rrggbb`, or null for the default.","isRequired":true,"uniqueKey":"widget.accent.oneOf.0","typeLabel":"string"},{"type":"null","description":"The accent colour as `#rrggbb`, or null for the default.","isRequired":true,"uniqueKey":"widget.accent.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"widget.accent","typeLabel":"string | null"},"height":{"type":"integer","minimum":420,"maximum":900,"description":"The open widget's height in pixels.","isRequired":true,"uniqueKey":"widget.height","typeLabel":"integer"},"welcomeScreen":{"type":"boolean","description":"Whether the widget opens on a welcome screen before the chat.","isRequired":true,"uniqueKey":"widget.welcomeScreen","typeLabel":"boolean"},"welcomeCollectLeads":{"type":"boolean","description":"Whether the welcome screen asks for the visitor's details.","isRequired":true,"uniqueKey":"widget.welcomeCollectLeads","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"widget","typeLabel":"object"},"voice":{"oneOf":[{"type":"object","description":"How it handles calls. `null` when the agent has no voice channel (a deployment without voice).","required":["answersCalls","surfaces","voice","phoneNumber","language","summariseCalls","detectMachines","recordCalls","recordDoNotCall","maxCallSeconds","ringSeconds","pastConversations","unavailableMessage","unavailableMessageNote","callStartUrl","thinking","thinkingLines","thinkingDelayMs","thinkingRepeatMs","thinkingAtTurnEnd","turnDetection","turnSilenceSeconds","interruptWords","neverInterrupt","earlyAnswers","holdShortSpeech","greetingUninterruptible","openingWaitsForCaller","openingWaitSeconds","ambience","ambienceVolume","speakingSpeed","backchannelDetection","backchannelWords","acknowledgements","acknowledgementWords","vocabulary","endCallOnFinish","nudgeAfterSeconds","nudges","nudgePhrase","endAfterSilenceSeconds","endPhrases","callInstructions","reaskAfterSeconds"],"properties":{"answersCalls":{"type":"boolean","description":"Whether the agent takes calls at all.","isRequired":true,"uniqueKey":"voice.oneOf.0.answersCalls","typeLabel":"boolean"},"surfaces":{"type":"array","items":{"type":"string","enum":["phone","web","whatsapp"],"uniqueKey":"voice.oneOf.0.surfaces.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Where it answers calls: a phone number, the call button on your website, WhatsApp calls. A new agent starts with `[\"web\", \"whatsapp\"]`, and `phone` is added when a number is attached. Set it with `voice.surfaces`.","isRequired":true,"uniqueKey":"voice.oneOf.0.surfaces","typeLabel":"enum\u003cstring>[]"},"voice":{"oneOf":[{"type":"string","description":"The voice id from List Voices it speaks with.","isRequired":true,"uniqueKey":"voice.oneOf.0.voice.oneOf.0","typeLabel":"string"},{"type":"null","description":"The voice id from List Voices it speaks with.","isRequired":true,"uniqueKey":"voice.oneOf.0.voice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.voice","typeLabel":"string | null"},"phoneNumber":{"oneOf":[{"type":"string","description":"The number it answers on, or null. Read-only.","isRequired":true,"uniqueKey":"voice.oneOf.0.phoneNumber.oneOf.0","typeLabel":"string"},{"type":"null","description":"The number it answers on, or null. Read-only.","isRequired":true,"uniqueKey":"voice.oneOf.0.phoneNumber.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.phoneNumber","typeLabel":"string | null"},"language":{"oneOf":[{"type":"string","description":"The language for calls, or null to follow the agent's `language`.","isRequired":true,"uniqueKey":"voice.oneOf.0.language.oneOf.0","typeLabel":"string"},{"type":"null","description":"The language for calls, or null to follow the agent's `language`.","isRequired":true,"uniqueKey":"voice.oneOf.0.language.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.language","typeLabel":"string | null"},"summariseCalls":{"type":"boolean","description":"Whether a summary is written after every call.","isRequired":true,"uniqueKey":"voice.oneOf.0.summariseCalls","typeLabel":"boolean"},"detectMachines":{"type":"boolean","description":"Whether it hangs up on an answering machine.","isRequired":true,"uniqueKey":"voice.oneOf.0.detectMachines","typeLabel":"boolean"},"recordCalls":{"type":"boolean","description":"Whether calls are recorded.","isRequired":true,"uniqueKey":"voice.oneOf.0.recordCalls","typeLabel":"boolean"},"recordDoNotCall":{"type":"boolean","description":"Whether the agent can add a caller to your do-not-call list when they ask not to be called again. True unless switched off.","isRequired":true,"uniqueKey":"voice.oneOf.0.recordDoNotCall","typeLabel":"boolean"},"maxCallSeconds":{"oneOf":[{"type":"integer","minimum":60,"maximum":1200,"description":"The longest a call may run, in seconds; null for the default ceiling of 20 minutes.","isRequired":true,"uniqueKey":"voice.oneOf.0.maxCallSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":60,"maximum":1200,"description":"The longest a call may run, in seconds; null for the default ceiling of 20 minutes.","isRequired":true,"uniqueKey":"voice.oneOf.0.maxCallSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.maxCallSeconds","typeLabel":"integer | null"},"ringSeconds":{"type":"integer","minimum":10,"maximum":60,"description":"How long a call the agent places rings before it is given up; 30 unless set. A call nobody answers in that time ends as `no_answer`.","isRequired":true,"uniqueKey":"voice.oneOf.0.ringSeconds","typeLabel":"integer"},"pastConversations":{"type":"string","enum":["fresh","quiet","recap"],"description":"What a call does with earlier conversations: `quiet` uses them without mentioning it, `recap` opens by recapping them, `fresh` uses nothing from before.","isRequired":true,"uniqueKey":"voice.oneOf.0.pastConversations","typeLabel":"enum\u003cstring>"},"unavailableMessage":{"oneOf":[{"type":"string","description":"What a caller hears when this agent's line is switched off, or null for the standard sentence.","isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessage.oneOf.0","typeLabel":"string"},{"type":"null","description":"What a caller hears when this agent's line is switched off, or null for the standard sentence.","isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessage.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessage","typeLabel":"string | null"},"unavailableMessageNote":{"oneOf":[{"type":"string","description":"Set when the saved message will not always be spoken as written: a message is read aloud only on Plivo numbers (English, or English in Roman letters) and Twilio numbers (English and Hindi), and in no other script — callers then hear the standard sentence. Numbers with other providers, and WhatsApp calling, never speak a message; that is not flagged here. The message itself is kept. Null when it is read as written, or there is no message.","isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessageNote.oneOf.0","typeLabel":"string"},{"type":"null","description":"Set when the saved message will not always be spoken as written: a message is read aloud only on Plivo numbers (English, or English in Roman letters) and Twilio numbers (English and Hindi), and in no other script — callers then hear the standard sentence. Numbers with other providers, and WhatsApp calling, never speak a message; that is not flagged here. The message itself is kept. Null when it is read as written, or there is no message.","isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessageNote.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.unavailableMessageNote","typeLabel":"string | null"},"callStartUrl":{"oneOf":[{"type":"string","format":"uri","description":"Where an inbound call asks your system who is calling before the agent answers, or null. See `callStartUrl` on the input for the request and the answer.","isRequired":true,"uniqueKey":"voice.oneOf.0.callStartUrl.oneOf.0","typeLabel":"string\u003curi>"},{"type":"null","format":"uri","description":"Where an inbound call asks your system who is calling before the agent answers, or null. See `callStartUrl` on the input for the request and the answer.","isRequired":true,"uniqueKey":"voice.oneOf.0.callStartUrl.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.callStartUrl","typeLabel":"string\u003curi> | null"},"thinking":{"type":"boolean","description":"Whether it says a short filler while a reply is slow. Default true.","isRequired":true,"uniqueKey":"voice.oneOf.0.thinking","typeLabel":"boolean"},"thinkingLines":{"type":"array","items":{"type":"string","uniqueKey":"voice.oneOf.0.thinkingLines.items.[INDEX]","typeLabel":"string"},"description":"Your own filler lines. Empty means the built-in ones, in the caller's language.","isRequired":true,"uniqueKey":"voice.oneOf.0.thinkingLines","typeLabel":"string[]"},"thinkingDelayMs":{"type":"integer","description":"Milliseconds of quiet before a filler. 900 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.thinkingDelayMs","typeLabel":"integer"},"thinkingRepeatMs":{"type":"integer","description":"Milliseconds before another filler may follow. 2500 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.thinkingRepeatMs","typeLabel":"integer"},"thinkingAtTurnEnd":{"type":"boolean","description":"Whether it acknowledges before every reply. Default false.","isRequired":true,"uniqueKey":"voice.oneOf.0.thinkingAtTurnEnd","typeLabel":"boolean"},"turnDetection":{"oneOf":[{"type":"string","enum":["smart","timer","timer_v2","ear",null],"description":"How the agent decides the caller has finished speaking: `smart`, `timer`, `timer_v2` or `ear`, or null when it follows the platform's own setting (the Voice page shows which). Reads null until you choose one.","isRequired":true,"uniqueKey":"voice.oneOf.0.turnDetection.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["smart","timer","timer_v2","ear",null],"description":"How the agent decides the caller has finished speaking: `smart`, `timer`, `timer_v2` or `ear`, or null when it follows the platform's own setting (the Voice page shows which). Reads null until you choose one.","isRequired":true,"uniqueKey":"voice.oneOf.0.turnDetection.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.turnDetection","typeLabel":"enum\u003cstring> | null"},"turnSilenceSeconds":{"oneOf":[{"type":"number","description":"Seconds of quiet that end the caller's turn, or null for the default (0.25 s on most lines). In `smart` it is a ceiling on how long the model may keep waiting (0.6 s when null). Reads null until you set a number.","isRequired":true,"uniqueKey":"voice.oneOf.0.turnSilenceSeconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"Seconds of quiet that end the caller's turn, or null for the default (0.25 s on most lines). In `smart` it is a ceiling on how long the model may keep waiting (0.6 s when null). Reads null until you set a number.","isRequired":true,"uniqueKey":"voice.oneOf.0.turnSilenceSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.turnSilenceSeconds","typeLabel":"number | null"},"reaskAfterSeconds":{"oneOf":[{"type":"number","description":"How long the agent waits, after a question it asked has had no answer, before it asks again: 1.5 to 10 seconds, `0` for never, or null for the platform's 2.5 seconds.","isRequired":true,"uniqueKey":"voice.oneOf.0.reaskAfterSeconds.oneOf.0","typeLabel":"number"},{"type":"null","description":"How long the agent waits, after a question it asked has had no answer, before it asks again: 1.5 to 10 seconds, `0` for never, or null for the platform's 2.5 seconds.","isRequired":true,"uniqueKey":"voice.oneOf.0.reaskAfterSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.reaskAfterSeconds","typeLabel":"number | null"},"interruptWords":{"type":"integer","description":"Words a caller must say to cut the agent off mid-sentence. 3 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.interruptWords","typeLabel":"integer"},"neverInterrupt":{"type":"boolean","description":"Whether the agent can never be cut off. Default false.","isRequired":true,"uniqueKey":"voice.oneOf.0.neverInterrupt","typeLabel":"boolean"},"earlyAnswers":{"type":"boolean","description":"On by default. The agent starts working on its reply the moment it has heard what the caller said, while it is still making sure they have finished, so the first words come sooner. If the caller goes on, that early reply is thrown away and never spoken or recorded, but it still costs the model's tokens: on an agent that runs on your own model key they are billed to your key and are not counted in the call's `usage`. `false` starts a reply only once the caller has finished.","isRequired":true,"uniqueKey":"voice.oneOf.0.earlyAnswers","typeLabel":"boolean"},"holdShortSpeech":{"type":"boolean","description":"Whether words too short to cut in are kept and answered when it stops. Default true.","isRequired":true,"uniqueKey":"voice.oneOf.0.holdShortSpeech","typeLabel":"boolean"},"greetingUninterruptible":{"type":"boolean","description":"Whether the greeting plays to the end on phone calls. Default false.","isRequired":true,"uniqueKey":"voice.oneOf.0.greetingUninterruptible","typeLabel":"boolean"},"openingWaitsForCaller":{"type":"boolean","description":"Whether the opening line waits for the person who picked up to speak first. Default false: it plays the moment the call connects. true: it plays right after their first words (a \"Hello\") or, if they stay silent, after four seconds. Phone calls on a voice agent; not used on a realtime model.","isRequired":true,"uniqueKey":"voice.oneOf.0.openingWaitsForCaller","typeLabel":"boolean"},"openingWaitSeconds":{"type":"number","description":"Seconds of silence after which a held opening line plays anyway (only with `openingWaitsForCaller`). 4 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.openingWaitSeconds","typeLabel":"number"},"ambience":{"oneOf":[{"type":"string","enum":["office","office-quiet",null],"description":"A background sound under the call, or null for none.","isRequired":true,"uniqueKey":"voice.oneOf.0.ambience.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["office","office-quiet",null],"description":"A background sound under the call, or null for none.","isRequired":true,"uniqueKey":"voice.oneOf.0.ambience.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.ambience","typeLabel":"enum\u003cstring> | null"},"ambienceVolume":{"type":"number","description":"The background sound's volume. 0.15 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.ambienceVolume","typeLabel":"number"},"speakingSpeed":{"type":"number","description":"How fast the agent talks, as a multiple of the voice's own pace. 1 unless set; 0.9 is a little slower.","isRequired":true,"uniqueKey":"voice.oneOf.0.speakingSpeed","typeLabel":"number"},"backchannelDetection":{"type":"boolean","description":"Ear mode only. Whether the agent tells a caller's backchannel (\"haan ji\", \"okay\", \"mm-hmm\") from a real interruption while it is talking. On unless set to false.","isRequired":true,"uniqueKey":"voice.oneOf.0.backchannelDetection","typeLabel":"boolean"},"backchannelWords":{"type":"array","items":{"type":"string","uniqueKey":"voice.oneOf.0.backchannelWords.items.[INDEX]","typeLabel":"string"},"description":"Ear mode only. Caller backchannel words that always mean \"I am listening\" for this agent, on top of what the agent recognises. Empty is the agent's own judgement alone.","isRequired":true,"uniqueKey":"voice.oneOf.0.backchannelWords","typeLabel":"string[]"},"acknowledgements":{"type":"boolean","description":"Ear mode only. Whether the agent speaks a short backchannel / acknowledgement while the caller pauses mid-explanation. On unless set to false; it is not part of the conversation record.","isRequired":true,"uniqueKey":"voice.oneOf.0.acknowledgements","typeLabel":"boolean"},"acknowledgementWords":{"type":"array","items":{"type":"string","uniqueKey":"voice.oneOf.0.acknowledgementWords.items.[INDEX]","typeLabel":"string"},"description":"Ear mode only. The agent's backchannel phrases, said in turn. Empty is a short word in the caller's own language.","isRequired":true,"uniqueKey":"voice.oneOf.0.acknowledgementWords","typeLabel":"string[]"},"vocabulary":{"type":"array","items":{"type":"string","uniqueKey":"voice.oneOf.0.vocabulary.items.[INDEX]","typeLabel":"string"},"description":"Names and terms the agent should hear correctly on calls: products, places, people. Empty is none.","isRequired":true,"uniqueKey":"voice.oneOf.0.vocabulary","typeLabel":"string[]"},"endCallOnFinish":{"type":"boolean","description":"Whether the line is released when the agent ends the conversation. A new agent starts with it off; an agent made earlier that never had it saved reads as true.","isRequired":true,"uniqueKey":"voice.oneOf.0.endCallOnFinish","typeLabel":"boolean"},"nudgeAfterSeconds":{"oneOf":[{"type":"integer","description":"Seconds of silence before it asks whether the caller is still there, or null to never ask.","isRequired":true,"uniqueKey":"voice.oneOf.0.nudgeAfterSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds of silence before it asks whether the caller is still there, or null to never ask.","isRequired":true,"uniqueKey":"voice.oneOf.0.nudgeAfterSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.nudgeAfterSeconds","typeLabel":"integer | null"},"nudges":{"type":"integer","description":"How many times it asks. 1 unless set.","isRequired":true,"uniqueKey":"voice.oneOf.0.nudges","typeLabel":"integer"},"nudgePhrase":{"oneOf":[{"type":"string","description":"What it asks, or null for the built-in question in the caller's language.","isRequired":true,"uniqueKey":"voice.oneOf.0.nudgePhrase.oneOf.0","typeLabel":"string"},{"type":"null","description":"What it asks, or null for the built-in question in the caller's language.","isRequired":true,"uniqueKey":"voice.oneOf.0.nudgePhrase.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.nudgePhrase","typeLabel":"string | null"},"endAfterSilenceSeconds":{"oneOf":[{"type":"integer","description":"Seconds of silence after which the call ends, or null, as you set it. On a call the hang-up is never earlier than the last question allows (`nudgeAfterSeconds × (nudges + 1)`), so a call can run longer than this number says.","isRequired":true,"uniqueKey":"voice.oneOf.0.endAfterSilenceSeconds.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Seconds of silence after which the call ends, or null, as you set it. On a call the hang-up is never earlier than the last question allows (`nudgeAfterSeconds × (nudges + 1)`), so a call can run longer than this number says.","isRequired":true,"uniqueKey":"voice.oneOf.0.endAfterSilenceSeconds.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.endAfterSilenceSeconds","typeLabel":"integer | null"},"endPhrases":{"type":"array","items":{"type":"string","uniqueKey":"voice.oneOf.0.endPhrases.items.[INDEX]","typeLabel":"string"},"description":"Phrases that end the call when the caller says them, stored lower-case without punctuation.","isRequired":true,"uniqueKey":"voice.oneOf.0.endPhrases","typeLabel":"string[]"},"callInstructions":{"oneOf":[{"type":"string","description":"How it should speak on calls, or null for the built-in call rules.","isRequired":true,"uniqueKey":"voice.oneOf.0.callInstructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"How it should speak on calls, or null for the built-in call rules.","isRequired":true,"uniqueKey":"voice.oneOf.0.callInstructions.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice.oneOf.0.callInstructions","typeLabel":"string | null"},"callStartSecret":{"type":"string","description":"The secret that signs call-start lookups. Present ONLY on the response to the request that set a new `callStartUrl` — store it now; it is never shown again. Setting a different address creates a new one.","uniqueKey":"voice.oneOf.0.callStartSecret","typeLabel":"string"},"realtimeVoice":{"oneOf":[{"type":"string","description":"Only for an agent on a realtime model (OpenAI GPT-Live-1 or OpenAI GPT-Realtime Mini): one of that model's own voices, from `voices` on its entry in List Models. null is its default. The agent's `voice` is kept as it is, for when it goes back to another model. Realtime models are on the Enterprise plan only for now: we set them up on your agents, they are not in List Models, and `model` refuses one as a new choice.","uniqueKey":"voice.oneOf.0.realtimeVoice.oneOf.0","typeLabel":"string"},{"type":"null","description":"Only for an agent on a realtime model (OpenAI GPT-Live-1 or OpenAI GPT-Realtime Mini): one of that model's own voices, from `voices` on its entry in List Models. null is its default. The agent's `voice` is kept as it is, for when it goes back to another model. Realtime models are on the Enterprise plan only for now: we set them up on your agents, they are not in List Models, and `model` refuses one as a new choice.","uniqueKey":"voice.oneOf.0.realtimeVoice.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.oneOf.0.realtimeVoice","typeLabel":"string | null"},"realtimeSession":{"type":"object","description":"OpenAI GPT-Realtime Mini's session settings (the Playground's Realtime session). Every field, with its value or default; ignored on any other model.","properties":{"noiseReduction":{"type":"string","enum":["auto","near_field","far_field","off"],"description":"Cleans the caller's audio first. `auto`: near_field on phone calls, far_field on web calls. Default auto.","uniqueKey":"voice.oneOf.0.realtimeSession.noiseReduction","typeLabel":"enum\u003cstring>"},"turnDetection":{"type":"string","enum":["server_vad","semantic_vad"],"description":"How it knows the caller has finished: `server_vad` by silence, `semantic_vad` by meaning. Default server_vad.","uniqueKey":"voice.oneOf.0.realtimeSession.turnDetection","typeLabel":"enum\u003cstring>"},"vadThreshold":{"type":"number","minimum":0,"maximum":1,"description":"By silence: how loud speech must be to count. Default 0.5.","uniqueKey":"voice.oneOf.0.realtimeSession.vadThreshold","typeLabel":"number"},"prefixPaddingMs":{"type":"number","minimum":0,"maximum":1000,"description":"By silence: audio kept from just before speech starts, ms. Default 300.","uniqueKey":"voice.oneOf.0.realtimeSession.prefixPaddingMs","typeLabel":"number"},"silenceDurationMs":{"type":"number","minimum":200,"maximum":2000,"description":"By silence: the quiet that ends the caller's turn, ms. Default 500.","uniqueKey":"voice.oneOf.0.realtimeSession.silenceDurationMs","typeLabel":"number"},"idleTimeoutMs":{"oneOf":[{"type":"number","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call.","uniqueKey":"voice.oneOf.0.realtimeSession.idleTimeoutMs.oneOf.0","typeLabel":"number"},{"type":"null","minimum":5000,"maximum":60000,"description":"By silence: after this much quiet the agent speaks up, ms; null is never (the default). Five quiet minutes from the caller still end the call.","uniqueKey":"voice.oneOf.0.realtimeSession.idleTimeoutMs.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.oneOf.0.realtimeSession.idleTimeoutMs","typeLabel":"number | null"},"eagerness":{"type":"string","enum":["auto","low","medium","high"],"description":"By meaning: how soon it decides the caller has finished. Default auto.","uniqueKey":"voice.oneOf.0.realtimeSession.eagerness","typeLabel":"enum\u003cstring>"},"interruptResponse":{"type":"boolean","description":"Whether a caller speaking cuts the agent off. Default true.","uniqueKey":"voice.oneOf.0.realtimeSession.interruptResponse","typeLabel":"boolean"},"transcriptionModel":{"type":"string","enum":["gpt-4o-mini-transcribe","gpt-4o-transcribe","whisper-1"],"description":"The caller's transcript: fast (the default), most accurate, or classic.","uniqueKey":"voice.oneOf.0.realtimeSession.transcriptionModel","typeLabel":"enum\u003cstring>"},"transcriptionPrompt":{"oneOf":[{"type":"string","maxLength":500,"description":"Names and brand words the transcript should get right; null is none.","uniqueKey":"voice.oneOf.0.realtimeSession.transcriptionPrompt.oneOf.0","typeLabel":"string"},{"type":"null","maxLength":500,"description":"Names and brand words the transcript should get right; null is none.","uniqueKey":"voice.oneOf.0.realtimeSession.transcriptionPrompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.oneOf.0.realtimeSession.transcriptionPrompt","typeLabel":"string | null"},"maxOutputTokens":{"oneOf":[{"type":"number","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default).","uniqueKey":"voice.oneOf.0.realtimeSession.maxOutputTokens.oneOf.0","typeLabel":"number"},{"type":"null","minimum":1,"maximum":4096,"description":"The longest single reply, in tokens; null is unlimited (the default).","uniqueKey":"voice.oneOf.0.realtimeSession.maxOutputTokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.oneOf.0.realtimeSession.maxOutputTokens","typeLabel":"number | null"},"speed":{"type":"number","minimum":0.25,"maximum":1.5,"description":"Speaking speed. Default 1.","uniqueKey":"voice.oneOf.0.realtimeSession.speed","typeLabel":"number"},"truncationRetention":{"oneOf":[{"type":"number","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default).","uniqueKey":"voice.oneOf.0.realtimeSession.truncationRetention.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0.1,"maximum":0.9,"description":"On a long call, the share of the conversation kept when it is trimmed; null lets the model decide (the default).","uniqueKey":"voice.oneOf.0.realtimeSession.truncationRetention.oneOf.1","typeLabel":"null"}],"uniqueKey":"voice.oneOf.0.realtimeSession.truncationRetention","typeLabel":"number | null"}},"uniqueKey":"voice.oneOf.0.realtimeSession","typeLabel":"object"}},"isRequired":true,"uniqueKey":"voice.oneOf.0","typeLabel":"object"},{"type":"null","description":"How it handles calls. `null` when the agent has no voice channel (a deployment without voice).","isRequired":true,"uniqueKey":"voice.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"voice","typeLabel":"object | null"},"byok":{"type":"string","enum":["workspace","off","all","voice","llm","llm_voice"],"description":"How this agent uses the workspace's own provider keys (Bring your own keys). `null` (or `workspace`) follows the workspace: its default scope applies when it brings its own keys. `off` never does: our voices and models at our normal pricing, whatever the workspace does, and the model is not held to the voice-only-BYOK model list. `all`, `voice`, `llm` or `llm_voice` runs this agent on that scope's keys whatever the workspace default is; refused with `409` naming the missing key unless the workspace holds verified keys for every kind that scope needs. If a key goes later, the agent falls back to the workspace's scope at the next call. Omit the field to leave it unchanged; saved BYOK model and voice choices are kept but not used while it is `off`. Read back as `workspace` when it follows the workspace.","isRequired":true,"uniqueKey":"byok","typeLabel":"enum\u003cstring>"},"collectFields":{"type":"array","description":"The details it fills in after every call, in the shape a call's `extract` takes. Empty when it collects nothing.","items":{"type":"object","description":"One detail the agent fills in after every call.","required":["name","type","description","choices"],"properties":{"name":{"type":"string","description":"The field's key in each call's results.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].name","typeLabel":"string"},"type":{"type":"string","enum":["text","number","integer","boolean","date"],"description":"The value's type.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"description":{"oneOf":[{"type":"string","description":"What to put in it, as the model reads it.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].description.oneOf.0","typeLabel":"string"},{"type":"null","description":"What to put in it, as the model reads it.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].description.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"collectFields.items.[INDEX].description","typeLabel":"string | null"},"choices":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"collectFields.items.[INDEX].choices.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"The values a text field must be one of, or null.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].choices.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"The values a text field must be one of, or null.","isRequired":true,"uniqueKey":"collectFields.items.[INDEX].choices.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"collectFields.items.[INDEX].choices","typeLabel":"string[] | null"}},"uniqueKey":"collectFields.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"collectFields","typeLabel":"object[]"},"webKey":{"oneOf":[{"type":"string","description":"The public key the website widget embeds (`pk_…`). It is published on your site, so it is not a secret.","isRequired":true,"uniqueKey":"webKey.oneOf.0","typeLabel":"string"},{"type":"null","description":"The public key the website widget embeds (`pk_…`). It is published on your site, so it is not a secret.","isRequired":true,"uniqueKey":"webKey.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"webKey","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","description":"When the agent was made.","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71","name":"Skyline Sales","instructions":"You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.","greeting":"Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?","businessDescription":"Skyline Homes builds 2 and 3 BHK apartments in Pune.","model":"prana-voice","temperature":0.4,"maxReplyTokens":300,"language":"Hindi","secondLanguage":null,"escalation":{"onNoAnswer":false,"onRequest":true},"captureLeads":true,"ownRules":false,"scheduleCallbacks":false,"steps":[],"widget":{"theme":"classic","accent":"#0f766e","height":806,"welcomeScreen":true,"welcomeCollectLeads":true},"voice":{"answersCalls":true,"surfaces":["web","whatsapp","phone"],"voice":"priya","phoneNumber":"+918047361290","language":null,"summariseCalls":true,"detectMachines":true,"recordCalls":true,"maxCallSeconds":300,"pastConversations":"recap","unavailableMessage":null,"unavailableMessageNote":null,"callStartUrl":null,"thinking":true,"thinkingLines":[],"thinkingDelayMs":900,"thinkingRepeatMs":2500,"thinkingAtTurnEnd":false,"turnSilenceSeconds":null,"turnDetection":null,"reaskAfterSeconds":null,"recordDoNotCall":true,"interruptWords":3,"neverInterrupt":false,"earlyAnswers":true,"holdShortSpeech":true,"greetingUninterruptible":false,"ambience":null,"ambienceVolume":0.15,"endCallOnFinish":false,"nudgeAfterSeconds":null,"nudges":1,"nudgePhrase":null,"endAfterSilenceSeconds":null,"endPhrases":[],"callInstructions":null},"byok":"workspace","collectFields":[],"webKey":"pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ","createdAt":"2026-09-17T09:39:31.204Z"},"examples":{"Example":{"title":"Example","value":{"id":"ag_5c4a5f93-2b1e-4d7a-9f60-8e2d1c3b4a71","name":"Skyline Sales","instructions":"You call people who enquired about a flat at Sky Towers, Baner. Find out their budget, preferred size and when they can visit the site.","greeting":"Namaste! Skyline Homes here — is this a good time to talk about Sky Towers?","businessDescription":"Skyline Homes builds 2 and 3 BHK apartments in Pune.","model":"prana-voice","temperature":0.4,"maxReplyTokens":300,"language":"Hindi","secondLanguage":null,"escalation":{"onNoAnswer":false,"onRequest":true},"captureLeads":true,"ownRules":false,"scheduleCallbacks":false,"steps":[],"widget":{"theme":"classic","accent":"#0f766e","height":806,"welcomeScreen":true,"welcomeCollectLeads":true},"voice":{"answersCalls":true,"surfaces":["web","whatsapp","phone"],"voice":"priya","phoneNumber":"+918047361290","language":null,"summariseCalls":true,"detectMachines":true,"recordCalls":true,"maxCallSeconds":300,"pastConversations":"recap","unavailableMessage":null,"unavailableMessageNote":null,"callStartUrl":null,"thinking":true,"thinkingLines":[],"thinkingDelayMs":900,"thinkingRepeatMs":2500,"thinkingAtTurnEnd":false,"turnSilenceSeconds":null,"turnDetection":null,"reaskAfterSeconds":null,"recordDoNotCall":true,"interruptWords":3,"neverInterrupt":false,"earlyAnswers":true,"holdShortSpeech":true,"greetingUninterruptible":false,"ambience":null,"ambienceVolume":0.15,"endCallOnFinish":false,"nudgeAfterSeconds":null,"nudges":1,"nudgePhrase":null,"endAfterSilenceSeconds":null,"endPhrases":[],"callInstructions":null},"byok":"workspace","collectFields":[],"webKey":"pk_9fQ2xLm7Rt4vWb8KcN3hYd6sJ1pZ","createdAt":"2026-09-17T09:39:31.204Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"f7ec7ef3-3eb1-4868-b3d6-335b754b5a0c":{"description":"A field breaks its rule, the body names nothing to change, or the new model or voice is not one you may use.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"empty":{"title":"empty","summary":"Nothing to change","value":{"error":"Nothing to change — the body named no field this API knows."}},"slow":{"title":"slow","summary":"Model too slow for calls","value":{"error":"That model is too slow to answer a call. Pick another."}},"voiceOnly":{"title":"voiceOnly","summary":"A voice-only model","value":{"error":"That model cannot be picked as an agent's model. Pick another."}},"seconds":{"title":"seconds","summary":"Call length out of range","value":{"error":"`voice.maxCallSeconds` must be between 60 and 1200."}},"language":{"title":"language","summary":"Unknown language","value":{"error":"`language` must be \"auto\" or a language the console offers, e.g. \"Hindi\"."}}},"exampleType":"examples"}},"exampleType":"examples"},"2058c030-0678-4951-be0d-64cf1f195408":{"description":"The key is missing, wrong or revoked. The answer is always the same, whichever it is.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Unauthorized","code":"unauthorized"},"examples":{"Example":{"title":"Example","value":{"error":"Unauthorized","code":"unauthorized"}}},"exampleType":"examples"}},"exampleType":"examples"},"0bf9f929-5246-4a82-abc1-69c212e83d29":{"description":"The key's access level (read-only or build) does not allow this request, the plan does not include it, or a customer's key named another workspace in `Thinnest-Workspace`. `code` says which: `key_scope_read`, `key_scope_build`, `workspace_header_forbidden`, or `forbidden`.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"readOnlyKey":{"title":"readOnlyKey","summary":"A read-only key tried to change something","value":{"error":"This API key is read-only. Use a build or full key to change anything.","code":"key_scope_read"}},"buildKey":{"title":"buildKey","summary":"A build key tried to message customers, send codes or place calls","value":{"error":"This API key is a build key: it can set up agents, actions, contacts and webhooks, but not message customers, send codes or place calls. Use a full key for that.","code":"key_scope_build"}},"customerKey":{"title":"customerKey","summary":"A customer's key named another workspace","value":{"error":"This key belongs to one customer workspace and cannot act as another.","code":"workspace_header_forbidden"}}},"exampleType":"examples"}},"exampleType":"examples"},"685dd2d4-5e4c-43cf-adac-b1cd136100fd":{"description":"No such agent in your workspace.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"That agent was not found."},"examples":{"Example":{"title":"Example","value":{"error":"That agent was not found."}}},"exampleType":"examples"}},"exampleType":"examples"},"7bc943dd-0177-4d5a-a657-3714be6d1913":{"description":"`voice.surfaces` adds `phone` while the agent answers calls and has no phone number to answer or call from. The `code` is `phone_number_required`; attach a number first, or switch `answersCalls` off while you set it up. Nothing was saved.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"`voice.surfaces` includes `phone`, but this agent has no phone number. Attach one first.","code":"phone_number_required"},"examples":{"Example":{"title":"Example","value":{"error":"`voice.surfaces` includes `phone`, but this agent has no phone number. Attach one first.","code":"phone_number_required"}}},"exampleType":"examples"}},"exampleType":"examples"},"322ae7e5-8d52-494b-b22b-01b17bd6b45f":{"description":"The customer named in `Thinnest-Workspace` was deleted. `POST /customers/{id}/restore` brings it back until its erase date.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"This workspace was deleted on 2026-10-06 and is erased on 2026-11-05. POST /v1/customers/{id}/restore brings it back until then.","code":"workspace_deleted"},"examples":{"Example":{"title":"Example","value":{"error":"This workspace was deleted on 2026-10-06 and is erased on 2026-11-05. POST /v1/customers/{id}/restore brings it back until then.","code":"workspace_deleted"}}},"exampleType":"examples"}},"exampleType":"examples"},"14033919-52ab-423b-972b-754f2c75e51c":{"description":"Over a per-minute limit. Wait for `Retry-After` seconds. `code` and `limit` say which limit: `rate_limit_resources` (240 requests a minute for the workspace), `rate_limit_family` (2,400 across a developer's customers), `rate_limit_calls`, `rate_limit_messages`, `rate_limit_codes`, `rate_limit_code_recipient`, `concurrent_calls` or `number_daily_limit`.","headers":{"Retry-After":{"schema":{"type":"integer"},"description":"Seconds to wait."}},"content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Over 240 requests a minute. Slow down and retry.","code":"rate_limit_resources","limit":{"name":"resources","perMinute":240}},"examples":{"Example":{"title":"Example","value":{"error":"Over 240 requests a minute. Slow down and retry.","code":"rate_limit_resources","limit":{"name":"resources","perMinute":240}}}},"exampleType":"examples"}},"exampleType":"examples"},"f8215371-285b-496c-9518-db869f2115cd":{"description":"Part of the change was not saved: the fields the agent collects, the `voice` settings, or a call-start signing secret. Send the same request again; settings that were saved before the failure are kept. The fields the agent collects are written first, so when they fail the voice settings were not applied and nothing is lost by repeating the request. A new signing secret is shown once, on the response that creates it: if a secret was created it is not shown, and the message says so. Send `voice.callStartSecret: \"rotate\"` for a new one (repeating the same `callStartUrl` creates nothing, because the address has not changed).","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"examples":{"voice":{"title":"voice","summary":"Voice settings not saved","value":{"error":"The voice settings could not be saved. Try again.","code":"internal_error"}},"fields":{"title":"fields","summary":"Collected fields not saved","value":{"error":"Saved the agent, but not the fields it collects, and its voice settings were not applied. Send the same request again.","code":"internal_error"}},"secret":{"title":"secret","summary":"Signing secret not shown","value":{"error":"The call-start address was saved, but its signing secret could not be created. Send `voice.callStartSecret: \"rotate\"` to get a new one.","code":"internal_error"}}},"exampleType":"examples"}},"exampleType":"examples"},"8f17d88a-3ae1-406f-9dde-10c4b09f6277":{"description":"A `voice.callStartUrl` (or `voice.callStartSecret: \"rotate\"`) was sent but call-start requests cannot be signed right now, so nothing was saved. The `code` is `signing_unavailable`; try again later.","content":{"application/json":{"schema":{"type":"object","required":["error","code"],"properties":{"error":{"type":"string","description":"What went wrong, in a sentence you can show a person.","isRequired":true,"uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","enum":["unauthorized","key_scope_read","key_scope_build","workspace_not_found","workspace_deleted","workspace_not_developer","workspace_header_forbidden","rate_limit_resources","rate_limit_family","rate_limit_calls","rate_limit_messages","rate_limit_codes","rate_limit_code_recipient","concurrent_calls","number_daily_limit","rate_limited","opted_out","do_not_call","stop_list_unknown","insufficient_balance","outside_calling_hours","number_never_callable","call_in_progress","call_already_scheduled","calling_not_set_up","carrier_unavailable","agent_not_found","agent_ambiguous","from_number_invalid","agent_on_live_call","phone_number_required","signing_unavailable","invalid_number","number_required","number_claimed_elsewhere","needs_own_carrier_keys","number_move_needs_developer","number_move_same_workspace","number_on_live_call","number_move_needs_business_details","number_move_carrier_account","number_move_unavailable","number_move_in_progress","number_move_legacy_number","number_cannot_forward","forward_destination_not_allowed","forward_loop","template_not_found","template_not_approved","template_language_missing","template_unsendable","code_template_not_found","code_template_ambiguous","whatsapp_not_connected","whatsapp_blocked","whatsapp_not_configured","free_allowance_used","send_failed","plan_required","plan_limit","payment_required","idempotency_in_progress","validation_failed","forbidden","not_found","conflict","gone","unprocessable","internal_error","service_unavailable"],"description":"A stable machine-readable code. Two refusals that share a status are told apart by it (a `403` for an opted-out customer, for the do-not-call list and for a key that is not a full key). See the table in the API reference under Errors.","isRequired":true,"uniqueKey":"code","typeLabel":"enum\u003cstring>"},"limit":{"type":"object","description":"On a `429` that hit one of our limits: which one and how big it is. `perMinute` for a per-minute limit; `max` (and `windowSeconds`) for the others.","required":["name"],"properties":{"name":{"type":"string","description":"Which limit: `resources`, `family`, `calls`, `messages`, `codes`, `code_recipient`, `concurrent_calls` or `number_daily`.","isRequired":true,"uniqueKey":"limit.name","typeLabel":"string"},"perMinute":{"type":"integer","description":"Requests allowed a minute.","uniqueKey":"limit.perMinute","typeLabel":"integer"},"max":{"type":"integer","description":"The most allowed, for a limit that is not per minute.","uniqueKey":"limit.max","typeLabel":"integer"},"windowSeconds":{"type":"integer","description":"The window `max` is counted over, when it has one.","uniqueKey":"limit.windowSeconds","typeLabel":"integer"}},"uniqueKey":"limit","typeLabel":"object"}},"example":{"error":"That agent was not found.","code":"not_found"},"description":"Every error body. Branch on `code`, never on the sentence in `error`: the sentence may be reworded, the code does not change.","uniqueKey":"","typeLabel":"object"},"example":{"error":"Call-start lookups cannot be signed on this deployment yet, so the address was not saved.","code":"signing_unavailable"},"examples":{"Example":{"title":"Example","value":{"error":"Call-start lookups cannot be signed on this deployment yet, so the address was not saved.","code":"signing_unavailable"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2ab51cb1-4826-4aaf-a310-84af0597cd2d":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"554b68ba-71a0-4ba5-bf79-928576071426":{"url":"https://app.thinnest.ai/api/v1","description":"Every workspace, in every country"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Your API key (`ta_live_…`) from **Settings → API keys**, sent as `Authorization: Bearer \u003ckey>`. Keep it on a server: it can message every customer you have. A key is full, build or read-only; a request its level does not allow is refused with `403`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"thinnestai","siteName":"ThinnestAI","title":"Update Agent - ThinnestAI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-10T05:30:10.989Z","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=\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.\">\u003cmeta data-mint-head name=\"application-name\" content=\"ThinnestAI\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update Agent - ThinnestAI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"ThinnestAI\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.thinnest.ai/api-reference/agents/update-agent\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://thinnestai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+Agent\u0026amp;description=Changes+any+subset+of+the+fields+Create+Agent+takes+and+answers+with+the+whole+agent.+Fields+you+leave+out+are+untouched%2C+and+unknown+fields+are+ignored+%E2%80%94+but+a\u0026amp;theme=d7927b3e8113ef719ec01f55\u0026amp;signature=f9931971cf18cf6b125c1cbd46ee113c4540899dfe080034851e6d21a3d36a89\">\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 - ThinnestAI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://thinnestai.mintlify.site/_mintlify/api/og/v2?division=Agents\u0026amp;title=Update+Agent\u0026amp;description=Changes+any+subset+of+the+fields+Create+Agent+takes+and+answers+with+the+whole+agent.+Fields+you+leave+out+are+untouched%2C+and+unknown+fields+are+ignored+%E2%80%94+but+a\u0026amp;theme=d7927b3e8113ef719ec01f55\u0026amp;signature=f9931971cf18cf6b125c1cbd46ee113c4540899dfe080034851e6d21a3d36a89\">\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/thinnestai/5DqVrbKlNMbN0dXk/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"ThinnestAI\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ff4e01\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.thinnest.ai/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.thinnest.ai/#organization\",\"name\":\"ThinnestAI\",\"url\":\"https://docs.thinnest.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/thinnestai/v8t9Y30dpMuNl6ae/logo/light.svg?fit=max\u0026auto=format\u0026n=v8t9Y30dpMuNl6ae\u0026q=85\u0026s=b9c83749f4bae8ed15285bc7d2b3dec4\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.thinnest.ai#website\",\"name\":\"ThinnestAI\",\"url\":\"https://docs.thinnest.ai\",\"publisher\":{\"@id\":\"https://docs.thinnest.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.thinnest.ai/api-reference/agents/update-agent#webpage\",\"url\":\"https://docs.thinnest.ai/api-reference/agents/update-agent\",\"name\":\"Update Agent\",\"description\":\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.\",\"dateModified\":\"2026-11-10T05:30:10.989Z\",\"isPartOf\":{\"@id\":\"https://docs.thinnest.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.thinnest.ai/api-reference/agents/update-agent#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.thinnest.ai/api-reference/agents/update-agent#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Agents\",\"item\":\"https://docs.thinnest.ai/api-reference/agents/list-agents\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Update Agent\",\"item\":\"https://docs.thinnest.ai/api-reference/agents/update-agent\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.thinnest.ai/api-reference/agents/update-agent#apireference\",\"headline\":\"Update Agent\",\"name\":\"Update Agent\",\"description\":\"Changes any subset of the fields Create Agent takes and answers with the whole agent. Fields you leave out are untouched, and unknown fields are ignored — but a body that names no field this API knows is refused. A model or voice is checked against your plan only when it changes, and a refused voice refuses the whole patch before anything is written. A build key may do this.\",\"url\":\"https://docs.thinnest.ai/api-reference/agents/update-agent\",\"mainEntityOfPage\":{\"@id\":\"https://docs.thinnest.ai/api-reference/agents/update-agent#webpage\"},\"dateModified\":\"2026-11-10T05:30:10.989Z\",\"publisher\":{\"@id\":\"https://docs.thinnest.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.thinnest.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"ThinnestAI\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"ThinnestAI\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/agents/update-agent.md","siteName":"ThinnestAI","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/guides/overview"}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"API reference","groups":[{"group":"Get started","pages":[{"title":"API reference","href":"/api-reference/introduction"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"title":"SDKs","href":"/api-reference/sdks"},{"title":"Customers","href":"/api-reference/customers"},{"title":"Bring your own keys","href":"/api-reference/bring-your-own-keys"},{"title":"Webhooks","href":"/api-reference/webhooks"}]},{"group":"Agents","pages":[{"title":"List Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents","href":"/api-reference/agents/list-agents"},{"title":"Create Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents","href":"/api-reference/agents/create-agent"},{"title":"Get Agent","description":"One agent: its instructions, model, languages, script, widget, call settings and the details it collects from calls. Which engine speaks its voice or runs its model is never part of the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}","href":"/api-reference/agents/get-agent"},{"title":"Update Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}","href":"/api-reference/agents/update-agent"},{"title":"Delete Agent","description":"Deletes the agent and everything under it: its conversations, knowledge, actions and channels. It cannot be undone. A **build** key may do this.\n\nRefused with `409` `agent_on_live_call` while the agent is on a call (ringing or connected): deleting it then would lose that call's recording, transcript, analysis and usage. Delete it after the call ends.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}","href":"/api-reference/agents/delete-agent"},{"title":"Get Agent BYOK Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/byok-model","href":"/api-reference/agents/get-agent-byok-model"},{"title":"Set Agent BYOK Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}/byok-model","href":"/api-reference/agents/set-agent-byok-model"},{"title":"Get Agent BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/byok-voice","href":"/api-reference/agents/get-agent-byok-voice"},{"title":"Set Agent BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /agents/{id}/byok-voice","href":"/api-reference/agents/set-agent-byok-voice"},{"title":"Test Chat","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/test-chat","href":"/api-reference/agents/test-chat"}]},{"group":"Knowledge","pages":[{"title":"List Knowledge Documents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/knowledge","href":"/api-reference/knowledge/list-knowledge-documents"},{"title":"Add Knowledge Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/knowledge","href":"/api-reference/knowledge/add-knowledge-document"},{"title":"Delete Knowledge Document","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/knowledge/{documentId}","href":"/api-reference/knowledge/delete-knowledge-document"}]},{"group":"Actions","pages":[{"title":"List Actions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/actions","href":"/api-reference/actions/list-actions"},{"title":"Create Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/actions","href":"/api-reference/actions/create-action"},{"title":"Get Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/actions/{actionId}","href":"/api-reference/actions/get-action"},{"title":"Update Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/actions/{actionId}","href":"/api-reference/actions/update-action"},{"title":"Delete Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/actions/{actionId}","href":"/api-reference/actions/delete-action"},{"title":"Test Action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/actions/{actionId}/test","href":"/api-reference/actions/test-action"}]},{"group":"Tools","pages":[{"title":"List Built-in Tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/tools","href":"/api-reference/tools/list-built-in-tools"},{"title":"Update Built-in Tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/tools","href":"/api-reference/tools/update-built-in-tools"},{"title":"List Tool Servers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/mcp-servers","href":"/api-reference/tools/list-tool-servers"},{"title":"Connect Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/mcp-servers","href":"/api-reference/tools/connect-tool-server"},{"title":"Get Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/mcp-servers/{serverId}","href":"/api-reference/tools/get-tool-server"},{"title":"Disconnect Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/mcp-servers/{serverId}","href":"/api-reference/tools/disconnect-tool-server"},{"title":"Sync Tool Server","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/mcp-servers/{serverId}/sync","href":"/api-reference/tools/sync-tool-server"},{"title":"Update Tool Server Tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/mcp-servers/{serverId}/tools/{toolId}","href":"/api-reference/tools/update-tool-server-tool"},{"title":"List Connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections","href":"/api-reference/tools/list-connections"},{"title":"Get Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections/{kind}","href":"/api-reference/tools/get-connection"},{"title":"Connect Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/connections/{kind}","href":"/api-reference/tools/connect-account"},{"title":"Configure Connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/connections/{kind}","href":"/api-reference/tools/configure-connection"},{"title":"Disconnect Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/connections/{kind}","href":"/api-reference/tools/disconnect-account"},{"title":"List Connection Options","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/connections/{kind}/options","href":"/api-reference/tools/list-connection-options"},{"title":"Replace Records Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/connections/records/link","href":"/api-reference/tools/replace-records-link"}]},{"group":"Channels","pages":[{"title":"Get Agent Channels","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/channels","href":"/api-reference/channels/get-agent-channels"},{"title":"Connect Telegram Bot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /agents/{id}/channels/telegram","href":"/api-reference/channels/connect-telegram-bot"},{"title":"Disconnect Telegram Bot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /agents/{id}/channels/telegram","href":"/api-reference/channels/disconnect-telegram-bot"}]},{"group":"Calls","pages":[{"title":"List Calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls","href":"/api-reference/calls/list-calls"},{"title":"Place Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls","href":"/api-reference/calls/place-call"},{"title":"Place Batch Calls","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /calls/batch","href":"/api-reference/calls/place-batch-calls"},{"title":"Get Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}","href":"/api-reference/calls/get-call"},{"title":"Cancel Call","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /calls/{id}","href":"/api-reference/calls/cancel-call"},{"title":"Get Call Transcript","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/transcript","href":"/api-reference/calls/get-call-transcript"},{"title":"Get Call Timeline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/timeline","href":"/api-reference/calls/get-call-timeline"}]},{"group":"Post-call","pages":[{"title":"Get Call Analysis","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/analysis","href":"/api-reference/post-call/get-call-analysis"},{"title":"Delete Call Content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /calls/{id}/content","href":"/api-reference/post-call/delete-call-content"},{"title":"Get Post-call Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/post-call","href":"/api-reference/post-call/get-post-call-settings"},{"title":"Update Post-call Settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /agents/{id}/post-call","href":"/api-reference/post-call/update-post-call-settings"}]},{"group":"Recordings","pages":[{"title":"Get Call Recording","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/{id}/recording","href":"/api-reference/recordings/get-call-recording"},{"title":"Get Recording By Signed Link","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /recordings/{callId}","href":"/api-reference/recordings/get-recording-by-signed-link"}]},{"group":"Conversations","pages":[{"title":"List Conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations","href":"/api-reference/conversations/list-conversations"},{"title":"List Conversation Messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversations/{id}/messages","href":"/api-reference/conversations/list-conversation-messages"},{"title":"Reply to Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/reply","href":"/api-reference/conversations/reply-to-conversation"},{"title":"Update Conversation Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/status","href":"/api-reference/conversations/update-conversation-status"},{"title":"Assign Conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /conversations/{id}/assign","href":"/api-reference/conversations/assign-conversation"}]},{"group":"Messages","pages":[{"title":"Send Message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /messages","href":"/api-reference/messages/send-message"}]},{"group":"One-time codes","pages":[{"title":"Send One-Time Code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes","href":"/api-reference/one-time-codes/send-one-time-code"},{"title":"List Code Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /codes/templates","href":"/api-reference/one-time-codes/list-code-templates"},{"title":"Create Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes/templates","href":"/api-reference/one-time-codes/create-code-template"},{"title":"Get Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /codes/templates/{id}","href":"/api-reference/one-time-codes/get-code-template"},{"title":"Update Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /codes/templates/{id}","href":"/api-reference/one-time-codes/update-code-template"},{"title":"Delete Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /codes/templates/{id}","href":"/api-reference/one-time-codes/delete-code-template"},{"title":"Submit Code Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /codes/templates/{id}/submit","href":"/api-reference/one-time-codes/submit-code-template"}]},{"group":"Contacts","pages":[{"title":"List Contacts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts","href":"/api-reference/contacts/list-contacts"},{"title":"Create Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contacts","href":"/api-reference/contacts/create-contact"},{"title":"Get Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contacts/{id}","href":"/api-reference/contacts/get-contact"},{"title":"Update Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contacts/{id}","href":"/api-reference/contacts/update-contact"},{"title":"Delete Contact","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contacts/{id}","href":"/api-reference/contacts/delete-contact"}]},{"group":"Do not call","pages":[{"title":"List Do-Not-Call Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /do-not-call","href":"/api-reference/do-not-call/list-do-not-call-numbers"},{"title":"Add Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /do-not-call","href":"/api-reference/do-not-call/add-do-not-call-number"},{"title":"Get Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /do-not-call/{phone}","href":"/api-reference/do-not-call/get-do-not-call-number"},{"title":"Remove Do-Not-Call Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /do-not-call/{phone}","href":"/api-reference/do-not-call/remove-do-not-call-number"}]},{"group":"Events","pages":[{"title":"Report Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /events","href":"/api-reference/events/report-event"}]},{"group":"Templates","pages":[{"title":"List Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates","href":"/api-reference/templates/list-templates"},{"title":"Create Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates","href":"/api-reference/templates/create-template"},{"title":"Get Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /templates/{name}","href":"/api-reference/templates/get-template"},{"title":"Update Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /templates/{name}","href":"/api-reference/templates/update-template"},{"title":"Delete Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /templates/{name}","href":"/api-reference/templates/delete-template"},{"title":"Submit Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /templates/{name}/submit","href":"/api-reference/templates/submit-template"}]},{"group":"Campaigns","pages":[{"title":"List Campaigns","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns","href":"/api-reference/campaigns/list-campaigns"},{"title":"Create Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns","href":"/api-reference/campaigns/create-campaign"},{"title":"Get Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /campaigns/{id}","href":"/api-reference/campaigns/get-campaign"},{"title":"Launch Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/launch","href":"/api-reference/campaigns/launch-campaign"},{"title":"Pause Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/pause","href":"/api-reference/campaigns/pause-campaign"},{"title":"Resume Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/resume","href":"/api-reference/campaigns/resume-campaign"},{"title":"Cancel Campaign","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /campaigns/{id}/cancel","href":"/api-reference/campaigns/cancel-campaign"}]},{"group":"Sequences","pages":[{"title":"List Sequences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences","href":"/api-reference/sequences/list-sequences"},{"title":"Create Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences","href":"/api-reference/sequences/create-sequence"},{"title":"Get Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sequences/{sequenceId}","href":"/api-reference/sequences/get-sequence"},{"title":"Update Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /sequences/{sequenceId}","href":"/api-reference/sequences/update-sequence"},{"title":"Delete Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sequences/{sequenceId}","href":"/api-reference/sequences/delete-sequence"},{"title":"Add Sequence Step","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/steps","href":"/api-reference/sequences/add-sequence-step"},{"title":"Activate Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/activate","href":"/api-reference/sequences/activate-sequence"},{"title":"Pause Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/pause","href":"/api-reference/sequences/pause-sequence"},{"title":"Enrol in Sequence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sequences/{sequenceId}/enrolments","href":"/api-reference/sequences/enrol-in-sequence"}]},{"group":"Forms","pages":[{"title":"List Forms","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /forms","href":"/api-reference/forms/list-forms"},{"title":"Create Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /forms","href":"/api-reference/forms/create-form"},{"title":"Get Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /forms/{id}","href":"/api-reference/forms/get-form"},{"title":"Update Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /forms/{id}","href":"/api-reference/forms/update-form"},{"title":"Delete Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /forms/{id}","href":"/api-reference/forms/delete-form"},{"title":"Publish Form","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /forms/{id}/publish","href":"/api-reference/forms/publish-form"}]},{"group":"Phone numbers","pages":[{"title":"List Phone Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers","href":"/api-reference/phone-numbers/list-phone-numbers"},{"title":"Rent Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers","href":"/api-reference/phone-numbers/rent-phone-number"},{"title":"Get Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/{number}","href":"/api-reference/phone-numbers/get-phone-number"},{"title":"Update Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /phone-numbers/{number}","href":"/api-reference/phone-numbers/update-phone-number"},{"title":"Release Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /phone-numbers/{number}","href":"/api-reference/phone-numbers/release-phone-number"},{"title":"Move Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/{number}/move","href":"/api-reference/phone-numbers/move-phone-number"},{"title":"Get Business Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/business-details","href":"/api-reference/phone-numbers/get-business-details"},{"title":"Send Business Details","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /phone-numbers/business-details","href":"/api-reference/phone-numbers/send-business-details"},{"title":"Search Available Phone Numbers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/available","href":"/api-reference/phone-numbers/search-available-phone-numbers"},{"title":"List Available Cities","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/available/cities","href":"/api-reference/phone-numbers/list-available-cities"},{"title":"Import Phone Number","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /phone-numbers/import","href":"/api-reference/phone-numbers/import-phone-number"},{"title":"List Carrier Accounts","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /phone-numbers/carrier-accounts","href":"/api-reference/phone-numbers/list-carrier-accounts"},{"title":"Save Carrier Account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /phone-numbers/carrier-accounts/{provider}","href":"/api-reference/phone-numbers/save-carrier-account"}]},{"group":"SMS","pages":[{"title":"Get SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sms/provider","href":"/api-reference/sms/get-sms-provider"},{"title":"Connect SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /sms/provider","href":"/api-reference/sms/connect-sms-provider"},{"title":"Disconnect SMS Provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sms/provider","href":"/api-reference/sms/disconnect-sms-provider"},{"title":"List SMS Templates","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sms/templates","href":"/api-reference/sms/list-sms-templates"},{"title":"Add SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/templates","href":"/api-reference/sms/add-sms-template"},{"title":"Update SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /sms/templates/{id}","href":"/api-reference/sms/update-sms-template"},{"title":"Delete SMS Template","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /sms/templates/{id}","href":"/api-reference/sms/delete-sms-template"},{"title":"Send Test SMS","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /sms/test","href":"/api-reference/sms/send-test-sms"}]},{"group":"Voices","pages":[{"title":"List Voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voices","href":"/api-reference/voices/list-voices"}]},{"group":"Voice clones","pages":[{"title":"List Voice Clones","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-clones","href":"/api-reference/voice-clones/list-voice-clones"},{"title":"Create Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /voice-clones","href":"/api-reference/voice-clones/create-voice-clone"},{"title":"Get Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /voice-clones/{id}","href":"/api-reference/voice-clones/get-voice-clone"},{"title":"Update Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /voice-clones/{id}","href":"/api-reference/voice-clones/update-voice-clone"},{"title":"Delete Voice Clone","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /voice-clones/{id}","href":"/api-reference/voice-clones/delete-voice-clone"}]},{"group":"Models","pages":[{"title":"List Models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /models","href":"/api-reference/models/list-models"}]},{"group":"Bring your own keys","pages":[{"title":"Get BYOK Status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok","href":"/api-reference/bring-your-own-keys/get-byok-status"},{"title":"Turn BYOK On or Off","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /byok","href":"/api-reference/bring-your-own-keys/turn-byok-on-or-off"},{"title":"List BYOK Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok/credentials","href":"/api-reference/bring-your-own-keys/list-byok-keys"},{"title":"Add BYOK Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /byok/credentials","href":"/api-reference/bring-your-own-keys/add-byok-key"},{"title":"Update BYOK Key Model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /byok/credentials/{kind}","href":"/api-reference/bring-your-own-keys/update-byok-key-model"},{"title":"Delete BYOK Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /byok/credentials/{kind}","href":"/api-reference/bring-your-own-keys/delete-byok-key"},{"title":"List BYOK Voices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /byok/voices","href":"/api-reference/bring-your-own-keys/list-byok-voices"},{"title":"Preview BYOK Voice","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /byok/voices/preview","href":"/api-reference/bring-your-own-keys/preview-byok-voice"}]},{"group":"Webhooks","pages":[{"title":"List Webhooks","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks","href":"/api-reference/webhooks/list-webhooks"},{"title":"Create Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks","href":"/api-reference/webhooks/create-webhook"},{"title":"Get Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}","href":"/api-reference/webhooks/get-webhook"},{"title":"Update Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /webhooks/{id}","href":"/api-reference/webhooks/update-webhook"},{"title":"Delete Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /webhooks/{id}","href":"/api-reference/webhooks/delete-webhook"},{"title":"List Webhook Deliveries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-webhook-deliveries"},{"title":"Test Webhook","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/test","href":"/api-reference/webhooks/test-webhook"},{"title":"Redeliver Webhook Events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /webhooks/{id}/redeliver","href":"/api-reference/webhooks/redeliver-webhook-events"}]},{"group":"Usage","pages":[{"title":"Get Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage","href":"/api-reference/usage/get-usage"},{"title":"Get Daily Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage/daily","href":"/api-reference/usage/get-daily-usage"},{"title":"List Call Log","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /usage/calls","href":"/api-reference/usage/list-call-log"},{"title":"List Wallet Ledger","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /wallet/ledger","href":"/api-reference/usage/list-wallet-ledger"},{"title":"List Invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invoices","href":"/api-reference/usage/list-invoices"},{"title":"Get Customers Usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/usage","href":"/api-reference/usage/get-customers-usage"},{"title":"Get Calls Summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /calls/summary","href":"/api-reference/usage/get-calls-summary"},{"title":"Get WhatsApp Summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /whatsapp/summary","href":"/api-reference/usage/get-whatsapp-summary"}]},{"group":"Analytics","pages":[{"title":"Get Dashboard","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard","href":"/api-reference/analytics/get-dashboard"},{"title":"Get Agent Analytics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /agents/{id}/analytics","href":"/api-reference/analytics/get-agent-analytics"}]},{"group":"Customers","pages":[{"title":"List Customers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers","href":"/api-reference/customers/list-customers"},{"title":"Create Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers","href":"/api-reference/customers/create-customer"},{"title":"Get Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{id}","href":"/api-reference/customers/get-customer"},{"title":"Update Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /customers/{id}","href":"/api-reference/customers/update-customer"},{"title":"Delete Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{id}","href":"/api-reference/customers/delete-customer"},{"title":"Restore Customer","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/{id}/restore","href":"/api-reference/customers/restore-customer"},{"title":"List Customer Keys","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customers/{id}/keys","href":"/api-reference/customers/list-customer-keys"},{"title":"Create Customer Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /customers/{id}/keys","href":"/api-reference/customers/create-customer-key"},{"title":"Revoke Customer Key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /customers/{id}/keys/{keyId}","href":"/api-reference/customers/revoke-customer-key"}]},{"group":"Workspace","pages":[{"title":"Get Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workspace","href":"/api-reference/workspace/get-workspace"},{"title":"Update Workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /workspace","href":"/api-reference/workspace/update-workspace"}]},{"group":"Projects","pages":[{"title":"List Projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects","href":"/api-reference/projects/list-projects"},{"title":"Create Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /projects","href":"/api-reference/projects/create-project"},{"title":"Get Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /projects/{id}","href":"/api-reference/projects/get-project"},{"title":"Update Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /projects/{id}","href":"/api-reference/projects/update-project"},{"title":"Delete Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /projects/{id}","href":"/api-reference/projects/delete-project"}]},{"group":"Teams","pages":[{"title":"List Teams","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams","href":"/api-reference/teams/list-teams"},{"title":"Create Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /teams","href":"/api-reference/teams/create-team"},{"title":"Get Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams/{id}","href":"/api-reference/teams/get-team"},{"title":"Update Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /teams/{id}","href":"/api-reference/teams/update-team"},{"title":"Delete Team","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}","href":"/api-reference/teams/delete-team"},{"title":"Add Team Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /teams/{id}/members/{memberId}","href":"/api-reference/teams/add-team-member"},{"title":"Remove Team Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}/members/{memberId}","href":"/api-reference/teams/remove-team-member"},{"title":"Grant Team Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /teams/{id}/projects/{projectId}","href":"/api-reference/teams/grant-team-project"},{"title":"Revoke Team Project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /teams/{id}/projects/{projectId}","href":"/api-reference/teams/revoke-team-project"}]},{"group":"Members","pages":[{"title":"List Members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members","href":"/api-reference/members/list-members"},{"title":"Get Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /members/{id}","href":"/api-reference/members/get-member"},{"title":"Update Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /members/{id}","href":"/api-reference/members/update-member"},{"title":"Remove Member","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /members/{id}","href":"/api-reference/members/remove-member"}]},{"group":"Invitations","pages":[{"title":"List Invitations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invitations","href":"/api-reference/invitations/list-invitations"},{"title":"Create Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /invitations","href":"/api-reference/invitations/create-invitation"},{"title":"Get Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invitations/{id}","href":"/api-reference/invitations/get-invitation"},{"title":"Revoke Invitation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /invitations/{id}","href":"/api-reference/invitations/revoke-invitation"}]},{"group":"Notifications","pages":[{"title":"Get Notification Preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification-preferences","href":"/api-reference/notifications/get-notification-preferences"},{"title":"Update Notification Preferences","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /notification-preferences","href":"/api-reference/notifications/update-notification-preferences"}]},{"group":"Saved replies","pages":[{"title":"List Saved Replies","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /saved-replies","href":"/api-reference/saved-replies/list-saved-replies"},{"title":"Create Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /saved-replies","href":"/api-reference/saved-replies/create-saved-reply"},{"title":"Get Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /saved-replies/{id}","href":"/api-reference/saved-replies/get-saved-reply"},{"title":"Update Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /saved-replies/{id}","href":"/api-reference/saved-replies/update-saved-reply"},{"title":"Delete Saved Reply","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /saved-replies/{id}","href":"/api-reference/saved-replies/delete-saved-reply"}]},{"group":"Contact groups","pages":[{"title":"List Contact Groups","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contact-groups","href":"/api-reference/contact-groups/list-contact-groups"},{"title":"Create Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contact-groups","href":"/api-reference/contact-groups/create-contact-group"},{"title":"Get Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contact-groups/{id}","href":"/api-reference/contact-groups/get-contact-group"},{"title":"Rename Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contact-groups/{id}","href":"/api-reference/contact-groups/rename-contact-group"},{"title":"Delete Contact Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contact-groups/{id}","href":"/api-reference/contact-groups/delete-contact-group"},{"title":"Add Contacts To Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contact-groups/{id}/members","href":"/api-reference/contact-groups/add-contacts-to-group"},{"title":"Remove Contacts From Group","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contact-groups/{id}/members","href":"/api-reference/contact-groups/remove-contacts-from-group"}]},{"group":"Workflows","pages":[{"title":"Start a Workflow Run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/{workflowId}/runs","href":"/api-reference/workflows/start-a-workflow-run"},{"title":"List Workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows","href":"/api-reference/workflows/list-workflows"},{"title":"Get a Workflow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows/{workflowId}","href":"/api-reference/workflows/get-a-workflow"},{"title":"Send a Workflow Event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /workflows/events","href":"/api-reference/workflows/send-a-workflow-event"}]}]},{"tab":"What's New","pages":[{"title":"What's New","href":"/whats-new"}]}]},"basePath":"","title":"Update Agent - ThinnestAI","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}