{
"agent": {
"id": "abc123def456ghi789jklm",
"created_at": "2025-10-14T12:00:00Z",
"created_by": "01J000000000000000000000001",
"updated_at": "2025-10-23T16:45:00Z",
"updated_by": "01J000000000000000000000002",
"customer_agent_id": "abc123def456ghi789jklm",
"display_name": "Updated Agent Name",
"model_type": "MODEL_TYPE_VOICE",
"phone_number": "+1234567890",
"endpoint": "https://api.example.com/agent",
"prompt": "Updated instructions...",
"metadata": {
"updated": true
},
"workflows": {},
"metric_ids": [],
"test_set_ids": [],
"knowledge_base_ids": [],
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-23T16:45:00Z"
}
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "page_size",
"description": "page_size must be between 1 and 100"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "x-api-key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Agent not found",
"details": [
{
"field": "agent_id",
"description": "Agent not found or not accessible by your organization"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Update agent
Update specific fields of an existing agent configuration.
{
"agent": {
"id": "abc123def456ghi789jklm",
"created_at": "2025-10-14T12:00:00Z",
"created_by": "01J000000000000000000000001",
"updated_at": "2025-10-23T16:45:00Z",
"updated_by": "01J000000000000000000000002",
"customer_agent_id": "abc123def456ghi789jklm",
"display_name": "Updated Agent Name",
"model_type": "MODEL_TYPE_VOICE",
"phone_number": "+1234567890",
"endpoint": "https://api.example.com/agent",
"prompt": "Updated instructions...",
"metadata": {
"updated": true
},
"workflows": {},
"metric_ids": [],
"test_set_ids": [],
"knowledge_base_ids": [],
"create_time": "2025-10-14T12:00:00Z",
"update_time": "2025-10-23T16:45:00Z"
}
}{
"error": {
"code": "INVALID_ARGUMENT",
"message": "Invalid request parameter",
"details": [
{
"field": "page_size",
"description": "page_size must be between 1 and 100"
}
]
}
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Authentication failed",
"details": [
{
"field": "x-api-key",
"description": "Invalid or missing API key"
}
]
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Agent not found",
"details": [
{
"field": "agent_id",
"description": "Agent not found or not accessible by your organization"
}
]
}
}{
"error": {
"code": "INTERNAL",
"message": "Internal server error",
"details": [
{
"description": "An unexpected error occurred"
}
]
}
}Authorizations
API key for authentication
Headers
Workspace that scopes this operation. When omitted, the organization's active default workspace is used when one can be resolved.
1 - 26Path Parameters
Agent resource ID
^[A-Za-z0-9]{22}$Body
Fields to update on an agent.
Human-readable agent name
1 - 200"Updated Agent Name"
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_EMAIL: Email-based text agents
- 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
- MODEL_TYPE_DEEPGRAM_REALTIME: Deepgram Voice Agent voice-to-voice agents
MODEL_TYPE_VOICE, MODEL_TYPE_OUTBOUND_VOICE, MODEL_TYPE_CHAT, MODEL_TYPE_CHAT_A2A, MODEL_TYPE_CHAT_WEBSOCKET, MODEL_TYPE_EMAIL, MODEL_TYPE_SMS, MODEL_TYPE_WEBSOCKET, MODEL_TYPE_LIVEKIT, MODEL_TYPE_DAILY, MODEL_TYPE_OPENAI_REALTIME, MODEL_TYPE_GEMINI_REALTIME, MODEL_TYPE_GROK_REALTIME, MODEL_TYPE_DEEPGRAM_REALTIME "MODEL_TYPE_VOICE"
Phone number in E.164 format or SIP address for voice/SMS agents
200"+9876543210"
Custom API endpoint URL
200"https://api.newexample.com/agent"
Agent instructions/system prompt
50000"Updated instructions..."
External identifier for the agent
1 - 200"my-support-agent"
Primary language for the agent
200"en"
Free-form agent attributes
{ "company_name": "Acme Corp" }
Simulator-specific configuration
{ "key": "value" }
Workflow configuration
{ "workflow": "config" }
Associated metric IDs
["abc123def456ghi789jklm"]
Associated test set IDs
["gT5wq2Hn"]
Tags associated with the agent
201 - 200["production"]
Response
Agent updated successfully
Agent configuration resource.
Note: The active field (soft delete status) is managed internally and not exposed in API responses.
Show child attributes
Show child attributes
Was this page helpful?