Skip to contentSkip to page list

Docs

Get Batches

Get the summary of a single batch run, including its completion flag

GET/api/v1/simulation-runs/batches/{batchRunId}
Request and response examples
request.py
import osimport requests​origin = "https://app.langwatch.ai"path = "/api/v1/simulation-runs/batches/<batchRunId>"api_key = os.environ["LANGWATCH_API_KEY"]headers = {    "X-Auth-Token": api_key,}​response = requests.get(    origin + path,    headers=headers,)print(response.json())

Success

application/json · Generated from schema

{  "batchRunId": "string",  "totalCount": 0,  "passCount": 0,  "failCount": 0,  "runningCount": 0,  "settledCount": 0,  "stalledCount": 0,  "lastRunAt": 0,  "lastUpdatedAt": 0,  "firstCompletedAt": 0,  "allCompletedAt": 0,  "isComplete": false,  "note": "string"}
api-reference/simulation-runs/get-batches

Authorization

X-Auth-Tokenstringheaderrequired

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

batchRunIdstringrequired
At least 1 character

Responses

200

Success

application/json

batchRunIdstringrequired
totalCountnumberrequired
passCountnumberrequired
failCountnumberrequired
runningCountnumberrequired
settledCountnumberrequired
stalledCountnumberrequired
lastRunAtnumberrequired
lastUpdatedAtnumberrequired
firstCompletedAtnumber | nullrequired
allCompletedAtnumber | nullrequiredDeprecated

Deprecated: read settledCount and isComplete instead. It carries the last update time of a batch where no run is running.

isCompletebooleanrequired

True when every run of the batch reached a terminal status.

notestring | null

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

404

Not found

application/json

errorstringrequired

Documentation