Skip to main content
POST
Create Replay Run

Authorizations

Authorization
string
header
required

Use Tuner API key (tr_api_...) or user session token. Find your API key in Workspace Settings > API Keys.

Path Parameters

agent_id
integer
required

Tuner's internal numeric ID for the agent.

workspace_id
integer
required

Workspace ID. Find this in Workspace > General Settings.

Body

application/json

Request to launch a deterministic replay run against one or more voice clip sets.

voice_clip_set_ids
integer[]
required

IDs of the voice clip sets to replay, 1 to 10 sets.

Required array length: 1 - 10 elements
Example:
repeat_count
integer
default:1

Number of times to replay each clip set (1-20). Defaults to 1. len(voice_clip_set_ids) * repeat_count must be at most 20.

Required range: 1 <= x <= 20
Example:

2

max_call_duration_minutes
integer
default:3

Maximum length of each replayed call, in minutes (1-12). Defaults to 3. A clip set whose worst-case call duration exceeds this is rejected.

Required range: 1 <= x <= 12
Example:

3

selected_eval_ids
integer[] | null

IDs of PASS_FAIL evals to grade the replayed calls with. Omit, null or [] means no evals are run (a latency-only run).

Example:
selected_intent_ids
integer[] | null

IDs of call intents to detect on the replayed calls.

Example:
replay_settings
ReplaySettingsInput · object | null

Overrides for the replay's turn-timing. Omitted fields use their defaults.

Example:

Response

Successful Response

The simulation run that was just started.

simulation_run_id
integer
required

ID of the new simulation run.

generated_count
integer
required

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.

success
boolean
required

Whether the run was accepted.

caller_persona_id
integer | null

ID of the caller persona used. Null for replay runs.

caller_persona
CallerPersonaResponse · object | null

The caller persona used. Null for replay runs.

simulation_profile_id
integer | null

ID of the simulation profile used, if one was given.

simulation_profile_name
string | null

Name of the simulation profile used, if one was given.

simulation_profile_snapshot
Simulation Profile Snapshot · object | null

Copy of the profile's fields as they were when the run started.

noise_environment_id
integer | null

ID of the background-noise environment used, if one was given.

noise_intensity
number | null

Gain applied to the background noise, if noise was used.

noise_environment
NoiseEnvironmentResponse · object | null

The background-noise environment used, if one was given.