Run Saved Scenarios
Start a run from saved scenarios.
Places a call for each scenario you pick from your scenario library by id. No new
scenarios are generated, so you can re-test the same cases. Each call is scored against
every PASS_FAIL eval on the agent. Atomic: if any id is invalid, the whole request is
rejected and nothing is created. To have Tuner generate new scenarios instead, use
Run AI-Generated Scenarios.
Authorizations
Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.
Path Parameters
Tuner's internal numeric ID for the agent.
Workspace ID. Find this in Workspace > General Settings.
Body
Request to start a run that places test calls against scenarios picked from the library.
ID of the caller persona (language and accent) the simulated caller uses. Get valid IDs from List Caller Personas.
1
IDs of the library scenarios to run, 1 to 20, in the order they are queued. Duplicates are rejected.
1 - 20 elementsMaximum length of each simulated call, in minutes (1-12). Defaults to 3.
1 <= x <= 123
ID of a simulation profile belonging to this agent. Its fields are given to the simulated caller as facts about themselves. Optional.
x > 012
ID of a background-noise environment to mix into the call. Get valid IDs from List Noise Environments. Must be sent together with noise_intensity.
x > 02
Gain applied to the background noise: 0.5, 1.0 or 1.5. Must be sent together with noise_environment_id.
1
Response
Successful Response
The simulation run that was just started.
ID of the new simulation run.
Number of test scenarios created so far. 0 for Run AI-Generated Scenarios, because generation is asynchronous; the full count for replay runs and runs from saved scenarios.
Whether the run was accepted.
ID of the caller persona used. Null for replay runs.
The caller persona used. Null for replay runs.
ID of the simulation profile used, if one was given.
Name of the simulation profile used, if one was given.
Copy of the profile's fields as they were when the run started.
ID of the background-noise environment used, if one was given.
Gain applied to the background noise, if noise was used.
The background-noise environment used, if one was given.