Skip to main content
POST
/
v1
/
retrievers
/
{retriever_id}
/
execute
/
batch
Batch Execute Retriever
curl --request POST \
  --url https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch \
  --header 'Content-Type: application/json' \
  --data '
{
  "queries": [
    {
      "inputs": {},
      "filters": {}
    }
  ],
  "settings": {},
  "concurrency": 5,
  "return_presigned_urls": false,
  "return_vectors": false
}
'
{
  "status": 123,
  "error": {
    "message": "<string>",
    "type": "<string>",
    "details": {}
  },
  "success": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

Examples:

"Bearer YOUR_API_KEY"

"Bearer YOUR_STRIPE_API_KEY"

​
authorization
string
​
X-Namespace
string

Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'. Falls back to ?namespace= query parameter if the header is omitted.

Examples:

"ns_abc123def456"

"production"

"my-namespace"

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

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.

Response

Successful Response