Skip to main content
PATCH
Partial Update Agent

Authorizations

Authorization
string
header
required

Your API key. Send in the Authorization header as: Bearer

Path Parameters

agent_id
string
required

Body

application/json
publish
boolean | null
default:true
name
string | null
Required string length: 1 - 100
description
string | null
voice_id
string | null
system_prompt
string | null
Minimum string length: 1
model
string | null
tools
string[] | null
knowledge_bases
string[] | null
knowledge
KnowledgeReference · object | null

Explicit legacy or RAG Knowledge Base reference

call_template_name
string | null
greeting_settings
GreetingSettings · object | null
inactivity_messages
InactivityMessage · object[] | null
temperature
number | null
Required range: 0 <= x <= 1
language_hint
string | null
time_exceeded_message
string | null
recording_enabled
boolean | null
join_timeout
string | null
max_duration
string | null
initial_output_medium
enum<string> | null
Available options:
MESSAGE_MEDIUM_VOICE,
MESSAGE_MEDIUM_TEXT,
MESSAGE_MEDIUM_UNSPECIFIED
vad_settings
VADSettings · object | null
built_in_config
BuiltInConfig · object | null
success_criteria
string | null
extraction_schema
Extraction Schema · object | null
crm_webhook_url
string | null
crm_webhook_secret
string | null

Response

Successful Response

data
PublicAgentResponse · object
required

Agent object

meta
ResponseMeta · object
required

Request metadata