Skip to main content
DELETE
Delete a batch
0 credits Requires batches:write permission. See the guide for examples and usage.

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <API_KEY>. Keys have full access unless restricted to scopes.

Path Parameters

batch_id
string
required

Batch ID.

Example:

"batch_9f2c8a"

Response

Batch and its stored results are permanently deleted.

request_id
string<uuid>
required

Unique ID of this request, also in X-Request-Id. Include it when contacting support.

Example:

"3f1c2a6e-8b4d-4c1e-9f0a-2d7b5e6c8a91"

id
string

ID of the deleted batch.

deleted
boolean

Always true on success.

key_metadata
object

Credits this request used and your remaining balance.