Skip to main content
POST
/
v1
/
simulation
/
runs
Dispatch a simulation run
curl --request POST \
  --url https://api-sandbox.featherhq.com/v1/simulation/runs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "channel": "voice",
  "tool_overrides": {}
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agent_revision_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "persona_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scenario_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tool_overrides": {},
  "status": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "error_text": "<string>",
  "inputs_snapshot": {},
  "created_at": "2023-11-07T05:31:56Z",
  "recording_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "recording_status": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Request body for POST /v1/simulation/runs.

Unlike :class:SimulationRunCreate (which describes a row that already has a Conversation), this is the public orchestrator payload: the service creates the session row and the run row in one transaction and then dispatches the Celery worker.

​
agent_id
string<uuid>
required
​
persona_id
string<uuid>
required
​
scenario_id
string<uuid>
required
​
agent_revision_id
string<uuid> | null
​
channel
enum<string>
default:voice
Available options:
text,
voice
​
tool_overrides
Tool Overrides · object

Response

Successful Response

​
id
string<uuid>
required
​
session_id
string<uuid>
required
​
organization_id
string<uuid>
required
​
agent_id
string<uuid>
required
​
agent_revision_id
string<uuid> | null
required
​
persona_id
string<uuid>
required
​
scenario_id
string<uuid>
required
​
channel
enum<string>
required
Available options:
text,
voice
​
tool_overrides
Tool Overrides · object
required
​
status
string
required
​
started_at
string<date-time> | null
required
​
finished_at
string<date-time> | null
required
​
error_text
string | null
required
​
inputs_snapshot
Inputs Snapshot · object
required
​
created_at
string<date-time>
required
​
recording_id
string<uuid> | null
​
recording_status
string | null