Python
import requests
url = "https://app.langwatch.ai/api/simulation-runs/batches/{batchRunId}"
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/batches/{batchRunId}', 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/batches/{batchRunId} \
--header 'X-Auth-Token: <api-key>'{
"batchRunId": "<string>",
"totalCount": 123,
"passCount": 123,
"failCount": 123,
"runningCount": 123,
"settledCount": 123,
"stalledCount": 123,
"lastRunAt": 123,
"lastUpdatedAt": 123,
"firstCompletedAt": 123,
"allCompletedAt": 123,
"isComplete": true
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}{
"error": "<string>",
"message": "<string>"
}Simulation Runs
Get Batches
Get the summary of a single batch run, including its completion flag
GET
/
api
/
simulation-runs
/
batches
/
{batchRunId}
Python
import requests
url = "https://app.langwatch.ai/api/simulation-runs/batches/{batchRunId}"
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/batches/{batchRunId}', 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/batches/{batchRunId} \
--header 'X-Auth-Token: <api-key>'{
"batchRunId": "<string>",
"totalCount": 123,
"passCount": 123,
"failCount": 123,
"runningCount": 123,
"settledCount": 123,
"stalledCount": 123,
"lastRunAt": 123,
"lastUpdatedAt": 123,
"firstCompletedAt": 123,
"allCompletedAt": 123,
"isComplete": true
}{
"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
Deprecated: read settledCount and isComplete instead. It carries the last update time of a batch where no run is running.
True when every run of the batch reached a terminal status.
Was this page helpful?
⌘I