Skip to main content
PATCH

Authorizations

​
x-api-key
string
header
required

API key for authentication

Path Parameters

​
agent_id
string
required

Agent resource ID

Pattern: ^[A-Za-z0-9]{22}$

Body

application/json

Partial update request (PATCH semantics - only provided fields are updated)

​
display_name
string

Human-readable agent name

Required string length: 1 - 200
Example:

"Updated Agent Name"

​
model_type
enum<string>

Agent type. Active types that can be created via the v1 API:

  • MODEL_TYPE_VOICE: Inbound voice calls (requires phone_number in E.164 format or SIP address)
  • MODEL_TYPE_OUTBOUND_VOICE: Outbound voice calls (requires endpoint webhook URL)
  • MODEL_TYPE_CHAT: Text-based chat agents (requires metadata.chat_endpoint)
  • MODEL_TYPE_CHAT_A2A: A2A JSON-RPC chat agents (requires metadata.chat_endpoint)
  • MODEL_TYPE_CHAT_WEBSOCKET: Text chat over WebSocket (requires metadata.endpoint in direct mode)
  • MODEL_TYPE_SMS: SMS messaging agents (requires phone_number in E.164 format)
  • MODEL_TYPE_WEBSOCKET: WebSocket voice agents (requires metadata.endpoint wss:// URL in direct mode; metadata.initialization_json is optional)
  • MODEL_TYPE_LIVEKIT: LiveKit agents (requires metadata.generate_token_endpoint and metadata.livekit_url)
  • MODEL_TYPE_DAILY: Pipecat Cloud agents (requires metadata.pipecat_api_key and metadata.agent_name)
  • MODEL_TYPE_OPENAI_REALTIME: OpenAI Realtime voice-to-voice agents
  • MODEL_TYPE_GEMINI_REALTIME: Gemini Live voice-to-voice agents
  • MODEL_TYPE_GROK_REALTIME: Grok (xAI) Voice Agent voice-to-voice agents
Available options:
MODEL_TYPE_VOICE,
MODEL_TYPE_OUTBOUND_VOICE,
MODEL_TYPE_CHAT,
MODEL_TYPE_CHAT_A2A,
MODEL_TYPE_CHAT_WEBSOCKET,
MODEL_TYPE_SMS,
MODEL_TYPE_WEBSOCKET,
MODEL_TYPE_LIVEKIT,
MODEL_TYPE_DAILY,
MODEL_TYPE_OPENAI_REALTIME,
MODEL_TYPE_GEMINI_REALTIME,
MODEL_TYPE_GROK_REALTIME
Example:

"MODEL_TYPE_VOICE"

​
phone_number
string | null

Phone number in E.164 format or SIP address for voice/SMS agents

Maximum string length: 200
Example:

"+9876543210"

​
endpoint
string | null

Custom API endpoint URL

Maximum string length: 200
Example:

"https://api.newexample.com/agent"

​
prompt
string | null

Agent instructions/system prompt

Example:

"Updated instructions..."

​
customer_agent_id
string | null

New external id for the agent

Required string length: 1 - 200
Example:

"my-support-agent"

​
language
string | null

Primary language for the agent

Maximum string length: 200
Example:

"en"

​
attributes
object | null

Free-form agent attributes. None means don't update; {} clears them.

Example:
​
metadata
object | null

Simulator-specific configuration (null = no change, {} = clear)

Example:
​
workflows
object | null

Workflow configuration (null = no change, {} = clear)

Example:
​
metric_ids
string[] | null

Associated metric IDs (null = no change, [] = clear)

Example:
​
test_set_ids
string[] | null

Associated test set IDs (null = no change, [] = clear)

Example:
​
tags
string[] | null

Tags to associate with this agent. Null or omitted leaves tags unchanged. Pass [] to clear all tags.

Example:

Response

Agent updated successfully

​
agent
object
required

Agent configuration resource.

Note: The active field (soft delete status) is managed internally and not exposed in API responses.