curl --request PUT \
--url https://api.zeroruntime.ai/v1/agents/{agentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"versionName": "Switch to booking flow",
"name": "Booking Agent",
"defaultLanguage": "english",
"languages": {
"english": {
"prompt": "You are a booking assistant for a dental clinic. Help callers book, move or cancel appointments, and confirm the date and time before ending the call.",
"greeting": {
"text": "Hello! Thanks for calling Bright Smile Dental. How can I help with your appointment?",
"interruptible": true
},
"stt": [
{
"model": "assemblyai/universal-streaming-english",
"language": "en"
}
],
"llm": [
{
"model": "google/gemini-3.5-flash"
}
],
"tts": [
{
"model": "deepgram/aura-2",
"voice": "apollo",
"language": "en"
}
],
"turnDetection": {
"model": "videosdk/echo-small",
"mode": "default"
},
"endCall": {
"enabled": true,
"when": "the appointment is confirmed or the caller says goodbye",
"message": "You're all set. See you at the clinic!"
}
}
},
"voiceProcessing": {
"noiseCancellation": {
"model": "aicoustics/quail-s-16khz"
}
},
"callSummary": {
"enabled": false
}
}
EOF
{
"agentId": "ag_7f2c91",
"name": "Support Agent",
"status": "active",
"deploymentId": "dp_44b1e0",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"versionId": "cm_31d0ba",
"config": {
"name": "Support Agent",
"languages": {
"english": {
"prompt": "You are a support agent for an online store. Keep replies to one or two sentences.",
"greeting": {
"text": "Hi! How can I help you today?",
"interruptible": false
},
"stt": [
{
"model": "deepgram/nova-3-general",
"language": "en"
}
],
"llm": [
{
"model": "openai/gpt-4o",
"apiKey": "••••••••••••••••AbCd"
}
],
"tts": [
{
"model": "cartesia/sonic-3",
"voice": "faf0731e-dfb9-4cfc-8119-259a79b27e12"
}
]
}
},
"defaultLanguage": "english",
"voiceProcessing": {
"vad": {
"sensitivity": "low",
"threshold": 0.5,
"minSpeechDuration": 1,
"minSilenceDuration": 1
},
"interruption": {
"mode": "hybrid",
"minDuration": 1,
"minWords": 1
},
"noiseCancellation": {
"model": "aicoustics/quail-l-16khz",
"provider": "<string>"
}
},
"knowledgeBaseIds": [
"<string>"
],
"callSummary": {
"enabled": true,
"llm": {
"model": "cartesia/sonic-3",
"voice": "<string>",
"language": "<string>",
"apiKey": "sk-proj-…"
},
"instruction": "<string>",
"webhook": {
"url": "<string>"
}
},
"tools": [
"<string>"
],
"advanced": {}
}
}{
"status": "error",
"errors": [
{
"path": "languages.english.tts[0].voice",
"code": "UNKNOWN_VOICE",
"message": "Sonic 3 has no voice called \"jacqueline\". Pick one from its voice list."
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}Agents
Update agent
Replaces the agent’s config and saves it as a new version. Send the whole config: anything you leave out is dropped.
Updating doesn’t change the running agent. Call Deploy agent to put the new version live.
PUT
/
v1
/
agents
/
{agentId}
curl --request PUT \
--url https://api.zeroruntime.ai/v1/agents/{agentId} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data @- <<EOF
{
"versionName": "Switch to booking flow",
"name": "Booking Agent",
"defaultLanguage": "english",
"languages": {
"english": {
"prompt": "You are a booking assistant for a dental clinic. Help callers book, move or cancel appointments, and confirm the date and time before ending the call.",
"greeting": {
"text": "Hello! Thanks for calling Bright Smile Dental. How can I help with your appointment?",
"interruptible": true
},
"stt": [
{
"model": "assemblyai/universal-streaming-english",
"language": "en"
}
],
"llm": [
{
"model": "google/gemini-3.5-flash"
}
],
"tts": [
{
"model": "deepgram/aura-2",
"voice": "apollo",
"language": "en"
}
],
"turnDetection": {
"model": "videosdk/echo-small",
"mode": "default"
},
"endCall": {
"enabled": true,
"when": "the appointment is confirmed or the caller says goodbye",
"message": "You're all set. See you at the clinic!"
}
}
},
"voiceProcessing": {
"noiseCancellation": {
"model": "aicoustics/quail-s-16khz"
}
},
"callSummary": {
"enabled": false
}
}
EOF
{
"agentId": "ag_7f2c91",
"name": "Support Agent",
"status": "active",
"deploymentId": "dp_44b1e0",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"versionId": "cm_31d0ba",
"config": {
"name": "Support Agent",
"languages": {
"english": {
"prompt": "You are a support agent for an online store. Keep replies to one or two sentences.",
"greeting": {
"text": "Hi! How can I help you today?",
"interruptible": false
},
"stt": [
{
"model": "deepgram/nova-3-general",
"language": "en"
}
],
"llm": [
{
"model": "openai/gpt-4o",
"apiKey": "••••••••••••••••AbCd"
}
],
"tts": [
{
"model": "cartesia/sonic-3",
"voice": "faf0731e-dfb9-4cfc-8119-259a79b27e12"
}
]
}
},
"defaultLanguage": "english",
"voiceProcessing": {
"vad": {
"sensitivity": "low",
"threshold": 0.5,
"minSpeechDuration": 1,
"minSilenceDuration": 1
},
"interruption": {
"mode": "hybrid",
"minDuration": 1,
"minWords": 1
},
"noiseCancellation": {
"model": "aicoustics/quail-l-16khz",
"provider": "<string>"
}
},
"knowledgeBaseIds": [
"<string>"
],
"callSummary": {
"enabled": true,
"llm": {
"model": "cartesia/sonic-3",
"voice": "<string>",
"language": "<string>",
"apiKey": "sk-proj-…"
},
"instruction": "<string>",
"webhook": {
"url": "<string>"
}
},
"tools": [
"<string>"
],
"advanced": {}
}
}{
"status": "error",
"errors": [
{
"path": "languages.english.tts[0].voice",
"code": "UNKNOWN_VOICE",
"message": "Sonic 3 has no voice called \"jacqueline\". Pick one from its voice list."
}
]
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
Your API token, sent raw (no Bearer prefix).
Path Parameters
Body
application/json
Example:
"Support Agent"
Keyed by language name (english, hindi, …). Holds everything that varies by language.
Show child attributes
Show child attributes
Example:
{ "english": { "prompt": "You are a support agent for an online store. Keep replies to one or two sentences.", "greeting": { "text": "Hi! How can I help you today?", "interruptible": false }, "stt": [ { "model": "deepgram/nova-3-general", "language": "en" } ], "llm": [ { "model": "openai/gpt-4o", "apiKey": "••••••••••••••••AbCd" } ], "tts": [ { "model": "cartesia/sonic-3", "voice": "faf0731e-dfb9-4cfc-8119-259a79b27e12" } ] } }
A language name, any casing.
Example:
"english"
Shared by every language.
Show child attributes
Show child attributes
Ids of the knowledge bases the agent answers from. An update replaces the list, so leaving it out removes them all.
Show child attributes
Show child attributes
Ids of the tools the agent can call. An update replaces the list, so leaving it out removes them all.
Label for the new version.
Response
The new version.
Example:
"ag_7f2c91"
Example:
"Support Agent"
active once deployed. A new agent stays inactive only if its first deploy couldn't run, for example when the account has no active API key. Call Deploy agent yourself then.
Available options:
inactive, active Example:
"active"
Example:
"dp_44b1e0"
Example:
"cm_31d0ba"
The config as stored, with names resolved.
Show child attributes
Show child attributes