Skip to main content
POST
TypeScript SDK

Authorizations

Authorization
string
header
required

Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.

Path Parameters

batchInferenceRunId
string
required

ID of the batch inference run, with prefix bir..

Pattern: ^bir\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$

Body

application/json

The body is of type object.

Response

Updated Batch Inference Run

A batch inference run with its quote, progress, charge, and output location.

blockedReason
enum<string> | null
required

Reason the run is blocked: funds to reserve the budget, payment to settle usage, or billing_review for staff review; otherwise null.

Available options:
funds,
payment,
billing_review
chargedAmount
string | null
required

Settled charge in US dollars as a decimal string, or null before a charge is recorded.

Pattern: ^(0|[1-9][0-9]*)(\.[0-9]+)?$
createdAt
string<date-time>
required

Time the batch inference run was created, as an ISO 8601 timestamp.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
datasetId
string
required

Dataset ID with prefix ds..

Pattern: ^ds\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
error
object | null
required

Failure or cancellation details, or null when no error is recorded.

id
string
required

ID of the batch inference run, with prefix bir..

Pattern: ^bir\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
message
string | null
required

Current status or billing explanation, or null when none is available.

mode
object
required

How each row is processed. Defaults to single_turn: one model call per row, with the answer written as text. More modes may be added, so branch on type.

model
object
required

The model to use: a catalog base model or a model version in this project containing a LoRA adapter or full weights. More model types may be added, so branch on type.

output
object
required

Dataset and field where this run writes completions.

progress
object | null
required

Latest generation progress while running or stopping; null in other states or when progress is unavailable.

projectId
string
required

Project ID with prefix pp..

Pattern: ^pp\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
quote
object | null
required

Price quote for confirmation, or null before a quote is ready.

result
object | null
required

Output counts and token usage, or null before results are available.

sampling
object
required

Generation settings used for each model call.

status
enum<string>
required

Run state from input preparation through confirmation, execution, and output writing; stopping is cancellation in progress, blocked requires action, and completed, failed, or canceled are terminal.

Available options:
preparing,
awaiting_confirmation,
queued,
running,
writing_outputs,
stopping,
blocked,
completed,
failed,
canceled
updatedAt
string<date-time>
required

Time the batch inference run was last updated, as an ISO 8601 timestamp.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$