import requests
url = "https://app.langwatch.ai/api/simulation-runs/{scenarioRunId}"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/simulation-runs/{scenarioRunId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/simulation-runs/{scenarioRunId} \
--header 'X-Auth-Token: <api-key>'{
"scenarioId": "<string>",
"batchRunId": "<string>",
"scenarioRunId": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"results": {
"verdict": "<string>",
"reasoning": "<string>",
"metCriteria": [
"<string>"
],
"unmetCriteria": [
"<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>",
"messagesTruncated": true,
"totalCost": 123,
"note": "<string>",
"scenarioVersion": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Get a single simulation run by its ID
Get a single simulation run by its ID
import requests
url = "https://app.langwatch.ai/api/simulation-runs/{scenarioRunId}"
headers = {"X-Auth-Token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-Auth-Token': '<api-key>'}};
fetch('https://app.langwatch.ai/api/simulation-runs/{scenarioRunId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request GET \
--url https://app.langwatch.ai/api/simulation-runs/{scenarioRunId} \
--header 'X-Auth-Token: <api-key>'{
"scenarioId": "<string>",
"batchRunId": "<string>",
"scenarioRunId": "<string>",
"name": "<string>",
"description": "<string>",
"status": "<string>",
"results": {
"verdict": "<string>",
"reasoning": "<string>",
"metCriteria": [
"<string>"
],
"unmetCriteria": [
"<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>",
"messagesTruncated": true,
"totalCost": 123,
"note": "<string>",
"scenarioVersion": 123
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Authorizations
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
Response
Success
Where the run stands. PENDING_EVALUATION means the conversation is over and the judge has decided, but the evaluators the run's suite and plan attach have not been recorded yet, so a required one may still fail the run. Wait for another status before reading the verdict as final.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
True when messages holds only the first few messages of a longer conversation. Pass include=messages to read them all.
One short line saying why the run was started, as given when it was queued. Null on a run started without one. Absent on servers that predate run notes.
The version of the scenario at the moment the run was queued. Null on runs recorded before versions existed. Absent on servers that predate scenario versions.
Was this page helpful?