Get a single simulation run by its ID

Get a single simulation run by its ID

GET /api/v1/simulation-runs/{scenarioRunId}

Python

Python

import requests

url = "https://app.langwatch.ai/api/v1/simulation-runs/{scenarioRunId}"

headers = {"X-Auth-Token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

200

{
  "scenarioId": "<string>",
  "batchRunId": "<string>",
  "scenarioRunId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "status": "<string>",
  "results": {
    "verdict": "<string>",
    "reasoning": "<string>",
    "metCriteria": [
      "<string>"
    ],
    "unmetCriteria": [
      "<string>"
    ],
    "inconclusiveCriteria": [
      "<string>"
    ],
    "criteria": [
      {
        "criterion": "<string>",
        "status": "passed",
        "reasoning": "",
        "requirement": "<string>"
      }
    ],
    "error": "<string>",
    "evaluations": [
      {
        "evaluatorId": "<string>",
        "name": "<string>",
        "status": "passed",
        "required": true,
        "passed": true,
        "score": 123,
        "label": "<string>",
        "details": "<string>",
        "cost": {
          "currency": "<string>",
          "amount": 123
        },
        "inputs": {}
      }
    ]
  },
  "messages": [
    {
      "role": "<string>",
      "content": "<string>"
    }
  ],
  "timestamp": 123,
  "updatedAt": 123,
  "durationInMs": 123,
  "platformUrl": "<string>",
  "scenarioSetId": "<string>",
  "messagesTruncated": true,
  "totalCost": 123,
  "roleCosts": {},
  "roleLatencies": {},
  "note": "<string>",
  "scenarioVersion": 0
}

Authorizations

X-Auth-Token · string · header · required

Project API key for sending traces and accessing project-scoped resources. Format: sk-lw-... (no underscore). Obtain one by creating a project via the Admin API or the LangWatch UI.

Path Parameters

scenarioRunId · string · required

Minimum string length: 1

Response

200

application/json

Success

scenarioId · string · required

batchRunId · string · required

scenarioRunId · string · required

name · string | null · required

description · string | null · required

status · string · required

results · object | null · required

Show child attributes

messages · object[] · required

Show child attributes

timestamp · number · required

updatedAt · number · required

durationInMs · number · required

platformUrl · string<uri> · required

scenarioSetId · string

messagesTruncated · boolean

True when messages holds only the first few messages of a longer conversation. Pass include=messages to read them all.

totalCost · number

roleCosts · object

Show child attributes

roleLatencies · object

Show child attributes

note · string | null

One short line saying why the run was started, as given when it was queued. Null on a run started without one.

scenarioVersion · integer | null

The version of the scenario at the moment the run was queued. Null on runs recorded before versions existed.

Required range: -9007199254740991 <= x <= 9007199254740991