Get analysis batch status

GET

/api/v1/analysis-batches/{id}

Read individual outcomes from an accepted analysis batch. Use itemKey to match each outcome to the original application row.

Before you call

Use the batchId from creation and the same scope required to create that kind of batch.

Required scope: analyses:write.

What happens next

Read item state, resourceId, attemptId, and errorCode. Items finish only after their admitted analysis reaches a terminal outcome. Fetch each report to distinguish completed, failed, and requires_action.

Recovery

completed means all item processing is terminal, not that every item succeeded. Do not resubmit successful items. A revoked key can stop unadmitted items while accepted work continues.

Follow the complete workflow · Errors and retries

Authorization

ApiKey

headerAuthorizationBearer <token>

Path Parameters

id*string

Resource ID returned by this resource's creation or list endpoint. See prerequisites for whether this is a report, interview, job, or batch ID.

Length1 <= length <= 100

Response Body

application/json

response

data*

# Set PROBB_URL and PROBB_API_KEY. Replace RESOURCE_ID if present.curl --fail-with-body -X GET "$PROBB_URL/api/v1/analysis-batches/RESOURCE_ID" \  -H "Authorization: Bearer $PROBB_API_KEY"

{  "data": {    "id": "batch_analyses",    "kind": "analyses",    "status": "completed",    "createdAt": "2026-09-29T12:00:00.000Z",    "expiresAt": "2026-09-29T13:00:00.000Z",    "items": [      {        "itemKey": "application-42",        "state": "succeeded",        "resourceId": "report_example",        "attemptId": "attempt_example",        "errorCode": null      }    ]  }}