v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB

Batch Search

Get Batch Job Info

Check the status of your batch job and retrieve results when processing is complete.

batch_id: Your job's unique identifier
status: Current processing state (pending, processing, completed, failed, or cancelled)
estimated_completion_time: A dynamic ISO 8601 timestamp indicating when the job is expected to finish. This adjusts in real-time based on system throughput and queue backlog.
output_file_url: Download link for your results (available when status is completed)

Once your batch reaches completed status, use the output_file_url to download a .jsonl file containing all results via a simple GET request.

Each line in your results file contains:

Field	Type	Description
line_number	int	Matches the line number from your original input file
status	string	Result status: success, error, timeout, or exception
query	object	The original search query you submitted
response	object	The Search response for this query
code	int	HTTP status code
error	string	Error description (only present if request failed)

For a step-by-step walkthrough, see the Batch Search how-to guide.

get/v1/search/batches/{batch_id}

batch_idstring required

batch_idstring required

The unique identifier for your batch job.

status'pending' | 'processing' | 'completed' | 'failed' | 'cancelled' required

Public-facing batch job status values.

output_file_urlstring uri nullable

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