Skip to main content
POST
Cancel a batch

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

a batch ID: batch_ and 32 lowercase hex digits

Example:

"batch_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

Response

The batch, cancelled

id
string
required

a batch ID: batch_ and 32 lowercase hex digits

Example:

"batch_0f8e2d1c4b3a49e8a7f6e5d4c3b2a190"

type
enum<string>
required
Available options:
batch
status
enum<string>
required
Available options:
running,
completed,
cancelled
tool_id
string
required
counts
object
required
items
object[]
required
more_results
boolean
required

true when finished items' results were left out to keep this answer under 1 MiB: read the batch again for them

created_at
string
required

a string to be decoded into a Date

updated_at
string
required

a string to be decoded into a Date

completed_at
string | null
required

a string to be decoded into a Date