Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

Your API key (as_live_…), created under Settings → API keys.

Path Parameters

id
string
required

The resource's unique id (UUID).

Body

application/json

Create or update an agent. SMS by default; set channel=voice and provide voice.voice_id for a voice agent. Beyond the persona, you can configure the full builder: guardrails, knowledge base, handoff rules, timing (sms), speech + call behavior (voice), and inbox routing.

name
string
required

Agent name.

Example:

"Debt-relief qualifier"

system_prompt
string
required

The agent's persona and instructions.

Example:

"You are a friendly assistant qualifying debt-relief leads…"

channel
enum<string>

sms (default) or voice.

Available options:
sms,
voice
Example:

"sms"

status
string

draft / active / paused.

Example:

"active"

goal
string

What a successful conversation achieves.

Example:

"Book a call with a specialist"

greeting
string

Opening message/line.

Example:

"Hi {first_name}! Quick question —"

model
string

Model tier.

max_turns
integer

Max back-and-forth turns before wrapping up.

Example:

20

handoff_keywords
string[]

Contact phrases that force a human handoff.

Example:
voice_id
string

Voice for a voice agent (or set voice.voice_id).

Example:

"11labs-Jenny"

language
string

Voice language (or set voice.language).

Example:

"en-US"

inbox
object

Inbox routing / human-handoff policy.

sms
object

SMS agent behavior. All optional; unset fields use sensible defaults.

voice
object

Voice agent build config. voice_id is required for a voice agent; the rest tune speech and call behavior.

Response

One agent.

ok
boolean
Example:

true

agent
object

An AI agent with its full configuration.