v1

latestOpenAPI 3.1.02026-07-2268276396.6 KB
Batch Search

Create a Batch Job

Process large volumes of requests asynchronously with 50% lower costs.

Batch Search provides a simple set of endpoints to initiate batch processing jobs, monitor progress as requests are executed, and collect results once processing completes.

Each batch begins with a .jsonl file where every line represents an individual Search request.

Once your input file is ready, call the following endpoint to obtain a batch_id and presigned_url.

Copy the presigned_url from the response. You will need this URL to upload your input file.

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

post/v1/search/batches

Response

OK

batch_idstring required

A unique identifier for your batch job. Use this ID to check the status of your batch.

presigned_urlstring uri required

A temporary, secure URL for uploading your input file. Upload your .jsonl file to this URL using a PUT request. Once uploaded, your batch job will begin processing automatically.

Example response

{
  "batch_id": "2211478e-45a8-4d2e-ac51-77e25f6f7c79",
  "presigned_url": "https://s3.amazonaws.com/bucket/file?X-Amz-Algorithm=..."
}