Scenarios

Create scenario

Creates a new scenario (dataset, script, or graph kind). Returns 202 with processing status.

post/simulate/scenarios/create/

Request

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

Request body

namestring required
descriptionstring
dataset_idstring uuid
kind'graph' | 'script' | 'dataset'
script_urlstring uri nullable
agent_definition_idstring uuid
agent_definition_version_idstring uuid nullable
custom_instructionstring
no_of_rowsinteger
generate_graphboolean
graphobject nullable
source_type'agent_definition' | 'prompt'
prompt_template_idstring uuid nullable
prompt_version_idstring uuid nullable
add_persona_automaticallyboolean
personasstring[]
agent_namestring
agent_promptstring
voice_providerstring
voice_namestring
modelstring
llm_temperaturenumber
initial_messagestring
max_call_duration_in_minutesinteger
interrupt_sensitivitynumber
conversation_speednumber
finished_speaking_sensitivitynumber
initial_message_delayinteger

Response

Accepted

messagestring
status'processing'

Changes

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