Skip to main content
POST
Queue Http Simulation Run
Integration Prompt for AI Agents
New: agent_version_idDeprecated: prompt_id. Same uuid, still works. If both are sent and they differ, the request is 400.
This endpoint initiates a new HTTP text simulation. Once a simulation is started, it is possible to send messages using the “Send HTTP Text Message” endpoint and receive them through the webhook configurable in the agent settings.

Headers

X-Organization-Id
string
X-API-Key
string
required

API key required to authenticate requests.

Body

application/json

Request model for HTTP simulation run

simulation_id
string
required

ID of the simulation to be run

prompt_id
string | null
deprecated

Deprecated. Use agent_version_id. Same uuid, still works.

agent_version_id
string | null

Agent version UUID associated with this run

knowledge_base_id
string | null

Deprecated and ignored for grounding (the worker resolves KB from the documents model). Kept as a loose optional pass-through so existing API integrations that still send it keep working.

digital_human_ids
string[] | null

Digital human IDs to be used in the simulation

runs_per_digital_human
integer | null

Optional per-run override for how many test_results to spawn per selected digital human. Falls back to 1 when omitted.

Required range: x > 0

Response

Successful Response

Response model for HTTP simulation run

simulation_run_id
string
required

ID of the created simulation run (experiment_run)

simulation_result_ids
string[]
required

IDs of the created simulation results (test results)

agent_id
string
required

ID of the agent associated with the simulation run

status
string
default:success

Status of the response