Retrievers

Batch Execute Retriever

Changed on

Execute a retriever against multiple queries in a single request. The retriever is fetched and optimized once, then executed concurrently against each query with bounded parallelism.

Use case: IP safety / copyright clearance — scan 20 media files against face, logo, or audio retrievers in one call instead of 60 sequential SSE requests.

Limits: 1-16 queries per batch (a 17th is refused with limits.max_queries), 1-20 concurrency.

Returns results keyed by query index with per-query documents and errors.

post/v1/retrievers/{retriever_id}/execute/batch

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

retriever_idstring required

Retriever ID or name.

Query parameters

return_presigned_urlsboolean

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_vectorsboolean

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

Request body

settingsobject nullable

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

concurrencyinteger

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

return_presigned_urlsboolean

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_vectorsboolean

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

streamboolean

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

unknown required

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 5d4c905106b4Revision changes
    • info

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API