simulate

Create a new simulator agent

post/simulate/simulator-agents/create/

Request

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

Request body

idstring uuid
namestring required

Name of the simulator agent

promptstring required

System prompt for the agent

voice_providerstring required

Voice service provider

voice_namestring required

Specific voice to use

interrupt_sensitivitynumber

Sensitivity for interruption detection (0-1)

conversation_speednumber

Speed of conversation (0.1-3.0)

finished_speaking_sensitivitynumber

Sensitivity for detecting when speaker has finished (0-1)

modelstring required

LLM model to use

llm_temperaturenumber

Temperature setting for LLM (0-2)

max_call_duration_in_minutesinteger

Maximum call duration in minutes (1-180)

initial_message_delayinteger

Delay before initial message in seconds (0-60)

initial_messagestring

Initial message to send when conversation starts

created_atstring date-time
updated_atstring date-time
organizationstring uuid

Organization this simulator agent belongs to

deletedboolean
deleted_atstring date-time nullable
logo_urlstring

Response

Created

idstring uuid
namestring required

Name of the simulator agent

promptstring required

System prompt for the agent

voice_providerstring required

Voice service provider

voice_namestring required

Specific voice to use

interrupt_sensitivitynumber

Sensitivity for interruption detection (0-1)

conversation_speednumber

Speed of conversation (0.1-3.0)

finished_speaking_sensitivitynumber

Sensitivity for detecting when speaker has finished (0-1)

modelstring required

LLM model to use

llm_temperaturenumber

Temperature setting for LLM (0-2)

max_call_duration_in_minutesinteger

Maximum call duration in minutes (1-180)

initial_message_delayinteger

Delay before initial message in seconds (0-60)

initial_messagestring

Initial message to send when conversation starts

created_atstring date-time
updated_atstring date-time
organizationstring uuid

Organization this simulator agent belongs to

deletedboolean
deleted_atstring date-time nullable
logo_urlstring

Changes

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