Skip to main content
GET
Get Simulation Run

Authorizations

X-API-KEY
string
header
required

Your API key for authentication.

x-org-id
string
header
required

Org impersonation via x-org-id. Superadmins may impersonate any org; admins may impersonate their direct sub-organizations. Enter the target organization ID to act as that org.

Path Parameters

run_id
string
required
Required string length: 24

Response

Successful Response

id
string
required
account_id
string
required

Account ID that owns this simulation run

agent_id
string
required

ID of the Agent being simulated

simulation_results_id
string
required

ID of the parent simulation results

scenario_id
string
required

ID of the Simulation Scenario being run

max_steps
integer
required

The maximum number of steps.

max_errors
integer
required

The maximum number of errors.

trial
integer
default:1

Trial number for this scenario (1 to num_trials).

simulated_lead_llm_args
AiSettingsModel · object

LLM configuration for the simulated user.

scenario_set_id
string | null

ID of the Scenario Set the scenario belongs to

status
enum<string>
default:pending

Current status of the simulation run

Available options:
pending,
running,
completed
created_at
string<date-time>

When this run record was created (UTC)

started_at
string<date-time> | null

The start time of the simulation. None if still PENDING.

completed_at
string<date-time> | null

The end time of the simulation. None if not yet COMPLETED.

duration_in_seconds
number | null

The duration of the simulation run.

termination_reason
enum<string> | null

The reason for the termination of the simulation.

Available options:
user_stop,
agent_stop,
max_steps,
too_many_tool_errors,
cancelled,
execution_error
agent_cost
number | null

The cost of the agent.

user_cost
number | null

The cost of the user.

reward_info
RewardInfo · object | null

The reward received by the agent.

messages
(SystemMessage · object | AssistantMessage · object | UserMessage · object | ToolMessage · object)[] | null

Complete simulation transcript

A system message.

error
string | null

Error message if the simulation failed.