curl --request POST \
--url https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"queries": [
{
"inputs": {},
"filters": {}
}
],
"settings": {},
"concurrency": 5,
"return_presigned_urls": false,
"return_vectors": false,
"stream": false
}
'import requests
url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"
payload = {
"queries": [
{
"inputs": {},
"filters": {}
}
],
"settings": {},
"concurrency": 5,
"return_presigned_urls": False,
"return_vectors": False,
"stream": False
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
queries: [{inputs: {}, filters: {}}],
settings: {},
concurrency: 5,
return_presigned_urls: false,
return_vectors: false,
stream: false
})
};
fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'queries' => [
[
'inputs' => [
],
'filters' => [
]
]
],
'settings' => [
],
'concurrency' => 5,
'return_presigned_urls' => false,
'return_vectors' => false,
'stream' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"
payload := strings.NewReader("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}"
response = http.request(request)
puts response.read_body{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Batch Execute Retriever
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-50 queries per batch, 1-20 concurrency.
Returns results keyed by query index with per-query documents and errors.
curl --request POST \
--url https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"queries": [
{
"inputs": {},
"filters": {}
}
],
"settings": {},
"concurrency": 5,
"return_presigned_urls": false,
"return_vectors": false,
"stream": false
}
'import requests
url = "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"
payload = {
"queries": [
{
"inputs": {},
"filters": {}
}
],
"settings": {},
"concurrency": 5,
"return_presigned_urls": False,
"return_vectors": False,
"stream": False
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
queries: [{inputs: {}, filters: {}}],
settings: {},
concurrency: 5,
return_presigned_urls: false,
return_vectors: false,
stream: false
})
};
fetch('https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'queries' => [
[
'inputs' => [
],
'filters' => [
]
]
],
'settings' => [
],
'concurrency' => 5,
'return_presigned_urls' => false,
'return_vectors' => false,
'stream' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch"
payload := strings.NewReader("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/retrievers/{retriever_id}/execute/batch")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"queries\": [\n {\n \"inputs\": {},\n \"filters\": {}\n }\n ],\n \"settings\": {},\n \"concurrency\": 5,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"stream\": false\n}"
response = http.request(request)
puts response.read_body{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"error": {
"details": {
"id": "ns_123",
"resource": "namespace"
},
"message": "Namespace not found",
"type": "NotFoundError"
},
"status": 404,
"success": false
}Authorizations
Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.
Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.
Path Parameters
Retriever ID or name.
Query Parameters
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.
Include vector embeddings in result documents. Also accepted as a body field — if either source is true, vectors are returned.
Body
Batch of queries to execute.
List of queries to execute (1-50). Each gets the same retriever pipeline.
1 - 50 elementsShow child attributes
Show child attributes
Shared settings applied to every query. Supports 'limit' (max results per query, default 10) and 'max_chunks' (for content-mode preprocessing).
Max concurrent executions (1-20). Higher = faster but more resource usage.
1 <= x <= 20Generate presigned URLs for S3-backed blobs and url-shaped fields. Also accepted as a query param — if either source is true, presigning is enabled.
Include vector embeddings in result documents. Also accepted as a query param — if either source is true, vectors are returned.
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
Was this page helpful?

