Skip to main content
GET
/
v1
/
simulation
/
run
/
{run_id}
Get Simulation Run
curl --request GET \
  --url https://api.eqho.ai/v1/simulation/run/{run_id} \
  --header 'X-API-KEY: <api-key>'
{
  "_id": "<string>",
  "account_id": "<string>",
  "agent_id": "<string>",
  "simulation_results_id": "<string>",
  "scenario_id": "<string>",
  "max_steps": 123,
  "max_errors": 123,
  "trial": 1,
  "simulated_lead_llm_args": {
    "ai_model": "<string>",
    "frequency_penalty": 123,
    "max_tokens": 123,
    "presence_penalty": 123,
    "temperature": 123,
    "reasoning": "none",
    "text_verbosity": "low"
  },
  "scenario_set_id": "<string>",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z",
  "duration_in_seconds": 123,
  "termination_reason": "user_stop",
  "agent_cost": 123,
  "user_cost": 123,
  "reward_info": {
    "reward": 123,
    "action_checks": [
      {
        "action": {
          "tool_call_id": "<string>",
          "name": "<string>",
          "arguments": {},
          "requestor": "assistant",
          "info": "<string>",
          "compare_args": [
            "<string>"
          ]
        },
        "action_match": true,
        "action_reward": 123
      }
    ],
    "nl_assertions": [
      {
        "nl_assertion": "<string>",
        "met": true,
        "justification": "<string>"
      }
    ],
    "reward_breakdown": {},
    "info": {}
  },
  "messages": [
    {
      "content": "<string>",
      "role": "system",
      "turn_idx": 123,
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "error": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

run_id
string
required
Required string length: 24

Response

Successful Response

A specific execution/run of a simulation scenario

_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_errors,
cancelled
agent_cost
number | null

The cost of the agent.

user_cost
number | null

The cost of the user.

reward_info
RewardInfo · object

The reward received by the agent.

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

Complete simulation transcript

A system message.

  • SystemMessage
  • AssistantMessage
  • UserMessage
  • ToolMessage
error
string | null

Error message if the simulation failed.