Skip to main content
GET
Retrieve batch prediction results

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

batch_prediction_id
string
required

The id of the batch prediction whose results should be streamed.

Response

Batch prediction result stream

One NDJSON result line for a submitted batch item.

object
enum<string>
required

The object type, which is always batch_prediction.result.

Available options:
batch_prediction.result
batch_id
string
required

The batch prediction id.

custom_id
string
required

The caller-defined item id from the create request.

status
enum<string>
required

Terminal status for an individual result line.

Available options:
succeeded,
errored,
canceled,
expired
output
object | null
required

The model output when status is succeeded; otherwise null.

error
object | null
required

Problem details when status is errored, canceled, or expired; otherwise null.