simulate

put/simulate/api/agent-definition-operations/{id}/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/api/agent-definition-operations/{id}/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Request body

idstring uuid
agent_namestring required

Name of the AI agent

agent_type'voice' | 'text'
contact_numberstring nullable

Phone number associated with the AI agent

inboundboolean required

Whether the agent handles inbound calls

target_speaks_firstboolean nullable

Whether the target agent speaks first (greets) in a hosted voice simulation. True: the simulator waits for the target's greeting; False: the simulator opens the conversation; null: derive from inbound/outbound. Retell targets always let the simulator open (SDK limitation).

descriptionstring required

Detailed description of the AI agent's purpose and capabilities

assistant_idstring nullable

External identifier for the assistant

providerstring nullable

Provider of the AI agent

language'ar' | 'bg' | 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ms' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'es' | 'sv' | 'tr' | 'uk' | 'vi' nullable

Language of the agent

languagesstring[] nullable
authentication_method'api_key' nullable
websocket_urlstring uri nullable

WebSocket URL for real-time communication with the agent

websocket_headersobject nullable

Headers to be sent to the websocket server

workspacestring uuid nullable
knowledge_basestring uuid nullable
organizationstring uuid

Organization this agent definition belongs to

api_keystring nullable

API key for the agent

observability_providerstring uuid nullable
created_atstring date-time
updated_atstring date-time
modelstring nullable

Model of the agent

model_detailsobject nullable

Details of the model

livekit_urlstring
livekit_api_keystring
livekit_api_secretstring

Response

OK

idstring uuid
agent_namestring required

Name of the AI agent

agent_type'voice' | 'text'
contact_numberstring nullable

Phone number associated with the AI agent

inboundboolean required

Whether the agent handles inbound calls

target_speaks_firstboolean nullable

Whether the target agent speaks first (greets) in a hosted voice simulation. True: the simulator waits for the target's greeting; False: the simulator opens the conversation; null: derive from inbound/outbound. Retell targets always let the simulator open (SDK limitation).

descriptionstring required

Detailed description of the AI agent's purpose and capabilities

assistant_idstring nullable

External identifier for the assistant

providerstring nullable

Provider of the AI agent

language'ar' | 'bg' | 'zh' | 'cs' | 'da' | 'nl' | 'en' | 'fi' | 'fr' | 'de' | 'el' | 'hi' | 'hu' | 'id' | 'it' | 'ja' | 'ko' | 'ms' | 'no' | 'pl' | 'pt' | 'ro' | 'ru' | 'sk' | 'es' | 'sv' | 'tr' | 'uk' | 'vi' nullable

Language of the agent

languagesstring[] nullable
authentication_method'api_key' nullable
websocket_urlstring uri nullable

WebSocket URL for real-time communication with the agent

websocket_headersobject nullable

Headers to be sent to the websocket server

workspacestring uuid nullable
knowledge_basestring uuid nullable
organizationstring uuid

Organization this agent definition belongs to

api_keystring nullable

API key for the agent

observability_providerstring uuid nullable
created_atstring date-time
updated_atstring date-time
modelstring nullable

Model of the agent

model_detailsobject nullable

Details of the model

livekit_urlstring
livekit_api_keystring
livekit_api_secretstring

Changes

No recorded changes to this operation across all 1 revision of this API.