Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A Liquid API key from the API keys page of Liquid Console, sent as Authorization: Bearer $LIQUID_API_KEY.

Path Parameters

id
string
required

The batch id.

Example:

"batch_abc123"

Response

200 - application/json

Successful response.

id
string

The batch id.

object
string

Always "batch".

endpoint
string

The endpoint each request targets.

input_file_id
string

The uploaded input file id.

output_file_id
string

Result file id, once completed.

error_file_id
string

Error file id, if any requests failed.

status
string

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

completion_window
string

The requested completion window.

request_counts
object

Live counts: { total, completed, failed }.

created_at
integer

Unix timestamp (seconds) of creation.

errors
object

Present when the input failed validation: { object: "list", data: [...] }.

metadata
object

Any metadata supplied at creation.