Run multiple list-documents queries concurrently.
curl --request POST \
--url https://api.mixpeek.com/v1/documents/list/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"queries": [
{
"key": "<string>",
"request": {
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"sort": {
"field": "created_at",
"direction": "desc"
},
"search": "<string>",
"cursor": "<string>",
"partition": {
"count": 4,
"index": 0
},
"include_total": true,
"return_presigned_urls": false,
"return_vectors": false,
"return_vector_names": false,
"group_by": "source_object_id",
"select": [
"metadata.title",
"content"
],
"expand": [
"customer_id"
],
"limit": 10,
"offset": 0,
"collection_ids": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.mixpeek.com/v1/documents/list/batch"
payload = { "queries": [
{
"key": "<string>",
"request": {
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": True
},
"sort": {
"field": "created_at",
"direction": "desc"
},
"search": "<string>",
"cursor": "<string>",
"partition": {
"count": 4,
"index": 0
},
"include_total": True,
"return_presigned_urls": False,
"return_vectors": False,
"return_vector_names": False,
"group_by": "source_object_id",
"select": ["metadata.title", "content"],
"expand": ["customer_id"],
"limit": 10,
"offset": 0,
"collection_ids": ["<string>"]
}
}
] }
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: [
{
key: '<string>',
request: {
filters: {
AND: [
{field: 'name', operator: 'eq', value: 'John'},
{field: 'age', operator: 'gte', value: 30}
],
OR: [
{field: 'status', operator: 'eq', value: 'active'},
{field: 'role', operator: 'eq', value: 'admin'}
],
NOT: [
{field: 'department', operator: 'eq', value: 'HR'},
{field: 'location', operator: 'eq', value: 'remote'}
],
case_sensitive: true
},
sort: {field: 'created_at', direction: 'desc'},
search: '<string>',
cursor: '<string>',
partition: {count: 4, index: 0},
include_total: true,
return_presigned_urls: false,
return_vectors: false,
return_vector_names: false,
group_by: 'source_object_id',
select: ['metadata.title', 'content'],
expand: ['customer_id'],
limit: 10,
offset: 0,
collection_ids: ['<string>']
}
}
]
})
};
fetch('https://api.mixpeek.com/v1/documents/list/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/documents/list/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' => [
[
'key' => '<string>',
'request' => [
'filters' => [
'AND' => [
[
'field' => 'name',
'operator' => 'eq',
'value' => 'John'
],
[
'field' => 'age',
'operator' => 'gte',
'value' => 30
]
],
'OR' => [
[
'field' => 'status',
'operator' => 'eq',
'value' => 'active'
],
[
'field' => 'role',
'operator' => 'eq',
'value' => 'admin'
]
],
'NOT' => [
[
'field' => 'department',
'operator' => 'eq',
'value' => 'HR'
],
[
'field' => 'location',
'operator' => 'eq',
'value' => 'remote'
]
],
'case_sensitive' => true
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'search' => '<string>',
'cursor' => '<string>',
'partition' => [
'count' => 4,
'index' => 0
],
'include_total' => true,
'return_presigned_urls' => false,
'return_vectors' => false,
'return_vector_names' => false,
'group_by' => 'source_object_id',
'select' => [
'metadata.title',
'content'
],
'expand' => [
'customer_id'
],
'limit' => 10,
'offset' => 0,
'collection_ids' => [
'<string>'
]
]
]
]
]),
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/documents/list/batch"
payload := strings.NewReader("{\n \"queries\": [\n {\n \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\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/documents/list/batch")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n {\n \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/documents/list/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 \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"key": "<string>",
"response": {
"pagination": {
"has_more": false,
"limit": 10,
"offset": 0,
"total_count": 1
},
"results": [
{
"collection_id": "col_articles",
"document_id": "doc_123",
"metadata": {
"title": "AI Article"
}
}
],
"stats": {
"avg_blobs_per_document": 1,
"total_documents": 1
}
},
"error": "<string>"
}
]
}{
"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
}{
"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
}Documents
Run multiple list-documents queries concurrently.
Execute up to 10 POST /v1/documents/list queries in parallel against the
same namespace and return their responses together.
Collapses dossier / multi-collection N+1 fan-outs into one round-trip. Each
sub-query is independent; a failure in one does not fail the batch — the
failing entry’s response is null and error carries a short message.
POST
/
v1
/
documents
/
list
/
batch
Run multiple list-documents queries concurrently.
curl --request POST \
--url https://api.mixpeek.com/v1/documents/list/batch \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"queries": [
{
"key": "<string>",
"request": {
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": true
},
"sort": {
"field": "created_at",
"direction": "desc"
},
"search": "<string>",
"cursor": "<string>",
"partition": {
"count": 4,
"index": 0
},
"include_total": true,
"return_presigned_urls": false,
"return_vectors": false,
"return_vector_names": false,
"group_by": "source_object_id",
"select": [
"metadata.title",
"content"
],
"expand": [
"customer_id"
],
"limit": 10,
"offset": 0,
"collection_ids": [
"<string>"
]
}
}
]
}
'import requests
url = "https://api.mixpeek.com/v1/documents/list/batch"
payload = { "queries": [
{
"key": "<string>",
"request": {
"filters": {
"AND": [
{
"field": "name",
"operator": "eq",
"value": "John"
},
{
"field": "age",
"operator": "gte",
"value": 30
}
],
"OR": [
{
"field": "status",
"operator": "eq",
"value": "active"
},
{
"field": "role",
"operator": "eq",
"value": "admin"
}
],
"NOT": [
{
"field": "department",
"operator": "eq",
"value": "HR"
},
{
"field": "location",
"operator": "eq",
"value": "remote"
}
],
"case_sensitive": True
},
"sort": {
"field": "created_at",
"direction": "desc"
},
"search": "<string>",
"cursor": "<string>",
"partition": {
"count": 4,
"index": 0
},
"include_total": True,
"return_presigned_urls": False,
"return_vectors": False,
"return_vector_names": False,
"group_by": "source_object_id",
"select": ["metadata.title", "content"],
"expand": ["customer_id"],
"limit": 10,
"offset": 0,
"collection_ids": ["<string>"]
}
}
] }
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: [
{
key: '<string>',
request: {
filters: {
AND: [
{field: 'name', operator: 'eq', value: 'John'},
{field: 'age', operator: 'gte', value: 30}
],
OR: [
{field: 'status', operator: 'eq', value: 'active'},
{field: 'role', operator: 'eq', value: 'admin'}
],
NOT: [
{field: 'department', operator: 'eq', value: 'HR'},
{field: 'location', operator: 'eq', value: 'remote'}
],
case_sensitive: true
},
sort: {field: 'created_at', direction: 'desc'},
search: '<string>',
cursor: '<string>',
partition: {count: 4, index: 0},
include_total: true,
return_presigned_urls: false,
return_vectors: false,
return_vector_names: false,
group_by: 'source_object_id',
select: ['metadata.title', 'content'],
expand: ['customer_id'],
limit: 10,
offset: 0,
collection_ids: ['<string>']
}
}
]
})
};
fetch('https://api.mixpeek.com/v1/documents/list/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/documents/list/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' => [
[
'key' => '<string>',
'request' => [
'filters' => [
'AND' => [
[
'field' => 'name',
'operator' => 'eq',
'value' => 'John'
],
[
'field' => 'age',
'operator' => 'gte',
'value' => 30
]
],
'OR' => [
[
'field' => 'status',
'operator' => 'eq',
'value' => 'active'
],
[
'field' => 'role',
'operator' => 'eq',
'value' => 'admin'
]
],
'NOT' => [
[
'field' => 'department',
'operator' => 'eq',
'value' => 'HR'
],
[
'field' => 'location',
'operator' => 'eq',
'value' => 'remote'
]
],
'case_sensitive' => true
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'search' => '<string>',
'cursor' => '<string>',
'partition' => [
'count' => 4,
'index' => 0
],
'include_total' => true,
'return_presigned_urls' => false,
'return_vectors' => false,
'return_vector_names' => false,
'group_by' => 'source_object_id',
'select' => [
'metadata.title',
'content'
],
'expand' => [
'customer_id'
],
'limit' => 10,
'offset' => 0,
'collection_ids' => [
'<string>'
]
]
]
]
]),
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/documents/list/batch"
payload := strings.NewReader("{\n \"queries\": [\n {\n \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\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/documents/list/batch")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"queries\": [\n {\n \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/documents/list/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 \"key\": \"<string>\",\n \"request\": {\n \"filters\": {\n \"AND\": [\n {\n \"field\": \"name\",\n \"operator\": \"eq\",\n \"value\": \"John\"\n },\n {\n \"field\": \"age\",\n \"operator\": \"gte\",\n \"value\": 30\n }\n ],\n \"OR\": [\n {\n \"field\": \"status\",\n \"operator\": \"eq\",\n \"value\": \"active\"\n },\n {\n \"field\": \"role\",\n \"operator\": \"eq\",\n \"value\": \"admin\"\n }\n ],\n \"NOT\": [\n {\n \"field\": \"department\",\n \"operator\": \"eq\",\n \"value\": \"HR\"\n },\n {\n \"field\": \"location\",\n \"operator\": \"eq\",\n \"value\": \"remote\"\n }\n ],\n \"case_sensitive\": true\n },\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"search\": \"<string>\",\n \"cursor\": \"<string>\",\n \"partition\": {\n \"count\": 4,\n \"index\": 0\n },\n \"include_total\": true,\n \"return_presigned_urls\": false,\n \"return_vectors\": false,\n \"return_vector_names\": false,\n \"group_by\": \"source_object_id\",\n \"select\": [\n \"metadata.title\",\n \"content\"\n ],\n \"expand\": [\n \"customer_id\"\n ],\n \"limit\": 10,\n \"offset\": 0,\n \"collection_ids\": [\n \"<string>\"\n ]\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"key": "<string>",
"response": {
"pagination": {
"has_more": false,
"limit": 10,
"offset": 0,
"total_count": 1
},
"results": [
{
"collection_id": "col_articles",
"document_id": "doc_123",
"metadata": {
"title": "AI Article"
}
}
],
"stats": {
"avg_blobs_per_document": 1,
"total_documents": 1
}
},
"error": "<string>"
}
]
}{
"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
}{
"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
}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, malformed, unknown, revoked, inactive or expired key returns 401; a key without the permission, scope or plan an operation needs returns 403.
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.
Body
application/json
Keys this body does not declare are ignored, and the response's warnings name them, until 2026-11-02; from 2026-11-02 they are refused with 422 extra_forbidden naming the accepted keys.
Batch-execute multiple namespace-scoped list-documents queries in parallel.
Intended to collapse dossier / multi-collection UI N+1 patterns into one
round-trip. Canvas pages that fan out 5–10 parallel list_documents
calls (e.g., scene counts + face clusters + scene archetypes filtered by
the same brand_slug) should bundle them here instead.
Queries to execute concurrently against the same namespace.
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Response
Successful Response
Response for POST /v1/documents/list/batch.
One entry per input query, in the same order as requested.
Show child attributes
Show child attributes
Was this page helpful?