Skip to main content
POST
Create Agent

Authorizations

Authorization
string
header
required

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

Headers

X-Idempotency-Key
string | null

Body

application/json

Agent create payload for Public API; clerk_org_id is set from API key context.

name
string
required
Required string length: 1 - 100
voice_id
string
required

UUID of the voice to use

system_prompt
string
required
Minimum string length: 1
description
string | null
model
string
default:ultravox-v0.7
tools
string[] | null

List of tool IDs

knowledge_bases
string[] | null

List of knowledge base IDs

knowledge
KnowledgeReference · object | null

Explicit legacy or RAG Knowledge Base reference

template_id
string | null

Template ID used to create this agent

clerk_org_id
string | null

Ignored; set from API key context

call_template_name
string | null
greeting_settings
GreetingSettings · object | null
inactivity_messages
InactivityMessage · object[] | null
temperature
number | null
default:0.3
Required range: 0 <= x <= 1
language_hint
string | null
default:en-US

BCP47 language code

time_exceeded_message
string | null
recording_enabled
boolean | null
default:false
join_timeout
string | null
default:30s
max_duration
string | null
default:3600s
initial_output_medium
enum<string> | null
default:MESSAGE_MEDIUM_VOICE
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