simulate

Get paginated list of agent definitions for the user's organization.

get/simulate/agent-definitions/

Request

  • Base URL: http://localhost:8000
  • URL: http://localhost:8000/simulate/agent-definitions/
  • Auth: one of:
    • API key in header X-Api-Key
    • API key in header X-Secret-Key

Query parameters

searchstring
agent_type'voice' | 'text'
agent_definition_idstring uuid
pageinteger
limitinteger

Response

OK

idstring uuid
agent_namestring

Name of the AI agent

agent_type'voice' | 'text'
contact_numberstring nullable

Phone number associated with the AI agent

inboundboolean

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

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
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

created_atstring date-time
updated_atstring date-time
latest_versionstring
latest_version_idstring
model_detailsobject nullable

Details of the model

modelstring nullable

Model of the agent

Changes

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