API OverviewBatches

Cancel batch

Cancel a batch; lines that already finished are kept and billed.

Authentication

AuthorizationBearer
Your production key sent as a bearer token.

Path parameters

batch_idstringRequired
Batch ID.

Response

Successful Response
idstring
Batch ID.
endpointstring
Request shape of the batch lines.
modelstring
Model the batch runs on.
statusstring

One of validating, in_progress, finalizing, cancelling, completed, failed, expired, or cancelled.

request_countsmap from strings to integers
Line counts by outcome.
created_atinteger
Unix timestamp in seconds.
expires_atinteger
Unix timestamp in seconds after which an unfinished batch expires.
object"batch"OptionalDefaults to batch
completed_atinteger or nullOptional
Unix timestamp in seconds when the batch finished.
usagemap from strings to any or nullOptional
Aggregate usage and cost, once known.
metadatamap from strings to any or nullOptional
Metadata you sent at creation.

Errors

422
Unprocessable Entity Error