Skip to main content
POST
Post Consortium Search Batch

Authorizations

X-API-Key
string
header
required

Body

multipart/form-data
file
file
required

Response

Successful Response

Returned when a batch is accepted and by the polling endpoint.

id
string<uuid>
required

The batch's id, used to poll status and fetch results.

state
enum<string>
required

Processing state of the batch.

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
created_at
string<date-time>
required

When the batch was accepted.

progress
number | null

Fraction of entries processed so far, in [0, 1].

Example:

0

completed_count
integer | null

Number of entries processed so far.

Example:

0

total_count
integer | null

Total number of entries in the batch.

Example:

100