Skip to main content
GET
/
v1
/
search
/
batches
/
{batch_id}
Get Batch Job Info
curl --request GET \
  --url https://api.bigdata.com/v1/search/batches/{batch_id} \
  --header 'X-API-KEY: <api-key>'
{
  "batch_id": "<string>",
  "status": "pending",
  "output_file_url": "<string>"
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

batch_id
string
required

Response

OK

batch_id
string
required

The unique identifier for your batch job.

status
enum<string>
required

Current processing state of your batch job. Poll this endpoint until status reaches completed or failed.

Available options:
pending,
processing,
completed,
failed,
cancelled
output_file_url
string<uri> | null

Presigned URL to download your results. Available only when status is completed. Use a simple GET request to download the .jsonl results file.