Skip to main content
PATCH
/
v1
/
update-agent
/
{agent_id}
curl -X PATCH https://api.voicy.co/v1/update-agent/550e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "Updated Agent Name",
    "begin_message": "Hello! How can I assist you today?"
  }'

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Updated Agent Name",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "name": "Acme Corp"
  },
  "voice_id": "openai:sage",
  "language": "en",
  "begin_message": "Hello! How can I assist you today?",
  "agent_prompt": "You are a helpful customer support agent...",
  "begin_message_mode": "static",
  "prompt_text_direction": "ltr",
  "vars_provided": [],
  "vars_extracted": [],
  "version": 3,
  "deployed_at": null,
  "agent_type": "singlePrompt",
  "notification_emails": []
}
Update the configuration of an existing agent. Only provided fields will be updated.

​
Path Parameters

​
agent_id
string
required
The unique identifier of the agent (UUID format).

​
Request Body

​
agent_name
string
Display name for the agent.
​
voice_id
string
Voice ID for text-to-speech.
​
language
string
Language code (e.g., he, en).
​
agent_prompt
string
System prompt that defines the agent’s behavior.
​
begin_message
string
Initial greeting message.
​
begin_message_mode
string
How the begin message is handled: static, dynamic, or off.
​
prompt_text_direction
string
Text direction: rtl or ltr.
​
vars_provided
array
Variable definitions for values that can be provided when initiating a call. If provided, replaces all existing vars_provided for this agent. Each item: {name, type, default_value, description}.
​
vars_extracted
array
Variable definitions for values the agent should extract during the call. If provided, replaces all existing vars_extracted for this agent. Each item: {name, type, description, required}.

​
Response

Returns the updated agent object. 
curl -X PATCH https://api.voicy.co/v1/update-agent/550e8400-e29b-41d4-a716-446655440001 \
  -H "Authorization: Bearer voicy_sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "agent_name": "Updated Agent Name",
    "begin_message": "Hello! How can I assist you today?"
  }'

{
  "agent_id": "550e8400-e29b-41d4-a716-446655440001",
  "agent_name": "Updated Agent Name",
  "account": {
    "id": "550e8400-e29b-41d4-a716-446655440099",
    "name": "Acme Corp"
  },
  "voice_id": "openai:sage",
  "language": "en",
  "begin_message": "Hello! How can I assist you today?",
  "agent_prompt": "You are a helpful customer support agent...",
  "begin_message_mode": "static",
  "prompt_text_direction": "ltr",
  "vars_provided": [],
  "vars_extracted": [],
  "version": 3,
  "deployed_at": null,
  "agent_type": "singlePrompt",
  "notification_emails": []
}