Skip to main content
POST
Create 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
caller_persona_id
integer
required
functional_count
integer
required
Required range: x >= 0
adversarial_count
integer
required
Required range: x >= 0
max_call_duration_minutes
integer
default:3
Required range: 1 <= x <= 12
simulation_profile_id
integer | null
Required range: x > 0
noise_environment_id
integer | null
Required range: x > 0
noise_intensity
number | null

Allowed gains: 0.5, 1.0, or 1.5

selected_eval_ids
integer[] | null
selected_intent_ids
integer[] | null

Response

Successful Response

simulation_run_id
integer
required
generated_count
integer
required
success
boolean
required
caller_persona_id
integer | null
caller_persona
CallerPersonaResponse · object | null
simulation_profile_id
integer | null
simulation_profile_name
string | null
simulation_profile_snapshot
Simulation Profile Snapshot · object | null
noise_environment_id
integer | null
noise_intensity
number | null
noise_environment
NoiseEnvironmentResponse · object | null

One selectable background environment.