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.
Get Batches
Get the summary of a single batch run, including its completion flag
Try this endpoint
app.langwatch.ai
API key · X-Auth-Token
Kept in this tab. Cleared when you reload.
The response appears below.
Request and response examples
request.py
import osimport requestsorigin = "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())const url = "https://app.langwatch.ai/api/v1/simulation-runs/batches/<batchRunId>";const response = await fetch(url, { method: "GET", headers: { "X-Auth-Token": process.env.LANGWATCH_API_KEY!, },});const data = await response.json();curl --request GET \ --url 'https://app.langwatch.ai/api/v1/simulation-runs/batches/<batchRunId>' \ --header "X-Auth-Token: $LANGWATCH_API_KEY"Call the LangWatch API from this project.Request: GET https://app.langwatch.ai/api/v1/simulation-runs/batches/<batchRunId>Reference: https://langwatch.ai/docs/api-reference/simulation-runs/get-batches.mdAuthentication: send the X-Auth-Token header, read from the LANGWATCH_API_KEY environment variable. Never hard-code the key.Use the HTTP client this project already uses, handle non-2xx responses, and show me the parsed result.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"}Not found
application/json · Generated from schema
{ "error": "string"}Path parameters
batchRunIdstringrequiredAt least 1 character
Responses
200Success
application/json
batchRunIdstringrequiredtotalCountnumberrequiredpassCountnumberrequiredfailCountnumberrequiredrunningCountnumberrequiredsettledCountnumberrequiredstalledCountnumberrequiredlastRunAtnumberrequiredlastUpdatedAtnumberrequiredfirstCompletedAtnumber | nullrequiredallCompletedAtnumber | nullrequiredDeprecatedDeprecated: read settledCount and isComplete instead. It carries the last update time of a batch where no run is running.
isCompletebooleanrequiredTrue when every run of the batch reached a terminal status.
notestring | nullOne short line saying why the batch was run, as given when it was queued. Null on a batch run without one.
404Not found
application/json
errorstringrequired