v3

OpenAPI 3.1.02026-07-31350397683.8 KB

HTTP Text Agent

Queue Http Simulation Run

Queue a new simulation run and test results for HTTP text agent. Takes simulation_id, optional prompt_id, knowledge_base_id, and digital_human_ids. If digital_human_ids is not provided, uses all digital humans for the simulation. Returns simulation_run_id (experiment_run_id) and simulation_result_ids (array of test result IDs).

post/v1/queue-http-text-simulation-run

Headers

X-API-Keystring required

API key required to authenticate requests.

Request body

simulation_idstring required

ID of the simulation to be run

prompt_idstring nullable

Prompt UUID associated with this run

knowledge_base_idstring nullable

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_idsstring[] nullable

Digital human IDs to be used in the simulation

runs_per_digital_humaninteger nullable

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

Response

Successful Response

simulation_run_idstring required

ID of the created simulation run (experiment_run)

simulation_result_idsstring[] required

IDs of the created simulation results (test results)

agent_idstring required

ID of the agent associated with the simulation run

statusstring

Status of the response