Skip to main content
POST
Batch Execute Retriever

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retriever_id
string
required

Retriever ID or name.

Query Parameters

return_presigned_urls
boolean
default:false

Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a body field — if either source is true, presigning is enabled.

return_vectors
boolean
default:false

Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.

Body

application/json

Batch of queries to execute.

queries
BatchQueryItem · object[]
required

List of queries to execute (1-50). Each gets the same retriever pipeline.

Required array length: 1 - 50 elements
settings
Settings · object | null

Shared settings applied to every query. Supports 'limit' (max results per query, default 10) and 'max_chunks' (for content-mode preprocessing).

concurrency
integer
default:5

Max concurrent executions (1-20). Higher = faster but more resource usage.

Required range: 1 <= x <= 20
return_presigned_urls
boolean
default:false

Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a query param — if either source is true, presigning is enabled.

return_vectors
boolean
default:false

Include vector embeddings in result documents. Also accepted as a query param — if either source is true, vectors are returned.

stream
boolean
default:false

Stream results via Server-Sent Events. Each query result is emitted as it completes, with keepalive pings every 15s to prevent proxy timeouts.

Response

Successful Response