Error
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"description": "<string>",
"model_provider": "<string>",
"model_name": "<string>",
"system_prompt": "<string>",
"temperature": 123,
"max_tokens": 123,
"first_message": "<string>",
"first_message_mode": "<string>",
"voice_provider": "<string>",
"voice_id": "<string>",
"voice_model": "<string>",
"voice_stability": 123,
"voice_similarity": 123,
"voice_speed": 123,
"transcriber_provider": "<string>",
"transcriber_model": "<string>",
"transcriber_language": "<string>",
"background_sound": "<string>",
"background_sound_url": "<string>",
"max_duration": 123,
"silence_timeout": 123,
"enable_end_call": true,
"voicemail_detection": true,
"voicemail_message": "<string>",
"server_url": "<string>",
"tool_ids": [
"<unknown>"
],
"rag_enabled": true,
"rag_config": {},
"status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"hipaa_compliance": true,
"audio_recording": true,
"logging": true,
"transcript_enabled": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Agents
Update Agent
Partially update an agent. Only provided fields are changed.
PATCH
/
agent
/
{agent_id}
Error
A valid request URL is required to generate request examples{
"id": "<string>",
"name": "<string>",
"user_id": "<string>",
"org_id": "<string>",
"description": "<string>",
"model_provider": "<string>",
"model_name": "<string>",
"system_prompt": "<string>",
"temperature": 123,
"max_tokens": 123,
"first_message": "<string>",
"first_message_mode": "<string>",
"voice_provider": "<string>",
"voice_id": "<string>",
"voice_model": "<string>",
"voice_stability": 123,
"voice_similarity": 123,
"voice_speed": 123,
"transcriber_provider": "<string>",
"transcriber_model": "<string>",
"transcriber_language": "<string>",
"background_sound": "<string>",
"background_sound_url": "<string>",
"max_duration": 123,
"silence_timeout": 123,
"enable_end_call": true,
"voicemail_detection": true,
"voicemail_message": "<string>",
"server_url": "<string>",
"tool_ids": [
"<unknown>"
],
"rag_enabled": true,
"rag_config": {},
"status": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>",
"hipaa_compliance": true,
"audio_recording": true,
"logging": true,
"transcript_enabled": true
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
APIKeyHeaderHTTPBearer
Path Parameters
Body
application/json
Partial update for an existing agent.
All fields are optional. Only provided (non-None) fields are written to the database. Use model_dump(exclude_none=True) to build the update payload.
Required string length:
1 - 100Required range:
0 <= x <= 2Required range:
1 <= x <= 8192Required range:
0 <= x <= 1Required range:
0 <= x <= 1Required range:
0.5 <= x <= 2Required range:
10 <= x <= 43200Required range:
5 <= x <= 300Response
Successful Response
Full agent object returned by the API.