Update Agent
Updates an existing agent's configuration.
Endpoint
Parameters
agent_id
string
Yes
Unique identifier of the agent to update
Authentication
Requires a valid API key or user authentication token.
Request Body
Request Fields
name
string
No
New display name for the agent
description
string
No
New description of the agent's purpose
system_prompt
string
No
New instructions for the agent's behavior
language
string
No
New language code (e.g., "en" for English)
voice_id
string
No
New voice identifier
tts_provider
string
No
New text-to-speech provider
stt_provider
string
No
New speech-to-text provider
llm_model
string
No
New language model to use
knowledge_base_ids
array
No
New list of knowledge base IDs
Response
Returns the updated agent object with its new configuration.
Response Format
Example Request
Example Response
Error Responses
400
Bad Request - Invalid input data
401
Unauthorized - Invalid or missing API key
403
Forbidden - Not authorized to update this agent
404
Not Found - Agent with the specified ID does not exist
500
Internal Server Error
Notes
Only provide the fields you want to update. Omitted fields will retain their current values.
The updated_at timestamp is automatically set to the current time.
Changes take effect immediately for new conversations.
Existing voice sessions may need to be restarted to apply the changes.
Last updated