curl --request POST \
--url https://api.mixpeek.com/v1/collections/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"limit": 500,
"page_size": 500,
"offset": 5000,
"page": 2,
"filters": {},
"sort": {
"field": "created_at",
"direction": "desc"
},
"sorts": [
{}
],
"search": "<string>",
"include_system": false,
"case_sensitive": false
}
'import requests
url = "https://api.mixpeek.com/v1/collections/list"
payload = {
"limit": 500,
"page_size": 500,
"offset": 5000,
"page": 2,
"filters": {},
"sort": {
"field": "created_at",
"direction": "desc"
},
"sorts": [{}],
"search": "<string>",
"include_system": False,
"case_sensitive": 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({
limit: 500,
page_size: 500,
offset: 5000,
page: 2,
filters: {},
sort: {field: 'created_at', direction: 'desc'},
sorts: [{}],
search: '<string>',
include_system: false,
case_sensitive: false
})
};
fetch('https://api.mixpeek.com/v1/collections/list', 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/collections/list",
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([
'limit' => 500,
'page_size' => 500,
'offset' => 5000,
'page' => 2,
'filters' => [
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'sorts' => [
[
]
],
'search' => '<string>',
'include_system' => false,
'case_sensitive' => 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/collections/list"
payload := strings.NewReader("{\n \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": 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/collections/list")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/list")
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 \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": false\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"collection_id": "col_a1b2c3d4e5",
"collection_name": "article_embeddings",
"description": "Simple text collection: News articles with text embeddings from bucket source",
"enabled": true,
"feature_extractor": {
"feature_extractor_name": "text_extractor",
"field_passthrough": [
{
"source_path": "title"
}
],
"input_mappings": {
"text": "content"
},
"version": "v1"
},
"input_schema": {
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "text"
}
}
},
"output_schema": {
"properties": {
"title": {
"type": "string"
},
"text_extractor_v1_embedding": {
"type": "array"
}
}
},
"source": {
"bucket_id": "bkt_articles",
"type": "bucket"
}
}
],
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>",
"next_cursor": "<string>"
},
"total_count": 123,
"stats": {
"total_documents": 0,
"avg_documents_per_collection": 0,
"collections_with_taxonomies": 0,
"total_feature_extractors": 0,
"total_taxonomies": 0,
"total_retrievers": 0
},
"warnings": [
{
"resource": "taxonomy",
"reason": "not found in namespace",
"next_step": "Fix the taxonomy_id on the stage, or create the taxonomy.",
"id": "tax_abc123",
"stage": "<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
}List Collections
This endpoint allows you to list collections.
curl --request POST \
--url https://api.mixpeek.com/v1/collections/list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"limit": 500,
"page_size": 500,
"offset": 5000,
"page": 2,
"filters": {},
"sort": {
"field": "created_at",
"direction": "desc"
},
"sorts": [
{}
],
"search": "<string>",
"include_system": false,
"case_sensitive": false
}
'import requests
url = "https://api.mixpeek.com/v1/collections/list"
payload = {
"limit": 500,
"page_size": 500,
"offset": 5000,
"page": 2,
"filters": {},
"sort": {
"field": "created_at",
"direction": "desc"
},
"sorts": [{}],
"search": "<string>",
"include_system": False,
"case_sensitive": 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({
limit: 500,
page_size: 500,
offset: 5000,
page: 2,
filters: {},
sort: {field: 'created_at', direction: 'desc'},
sorts: [{}],
search: '<string>',
include_system: false,
case_sensitive: false
})
};
fetch('https://api.mixpeek.com/v1/collections/list', 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/collections/list",
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([
'limit' => 500,
'page_size' => 500,
'offset' => 5000,
'page' => 2,
'filters' => [
],
'sort' => [
'field' => 'created_at',
'direction' => 'desc'
],
'sorts' => [
[
]
],
'search' => '<string>',
'include_system' => false,
'case_sensitive' => 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/collections/list"
payload := strings.NewReader("{\n \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": 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/collections/list")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/list")
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 \"limit\": 500,\n \"page_size\": 500,\n \"offset\": 5000,\n \"page\": 2,\n \"filters\": {},\n \"sort\": {\n \"field\": \"created_at\",\n \"direction\": \"desc\"\n },\n \"sorts\": [\n {}\n ],\n \"search\": \"<string>\",\n \"include_system\": false,\n \"case_sensitive\": false\n}"
response = http.request(request)
puts response.read_body{
"results": [
{
"collection_id": "col_a1b2c3d4e5",
"collection_name": "article_embeddings",
"description": "Simple text collection: News articles with text embeddings from bucket source",
"enabled": true,
"feature_extractor": {
"feature_extractor_name": "text_extractor",
"field_passthrough": [
{
"source_path": "title"
}
],
"input_mappings": {
"text": "content"
},
"version": "v1"
},
"input_schema": {
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "text"
}
}
},
"output_schema": {
"properties": {
"title": {
"type": "string"
},
"text_extractor_v1_embedding": {
"type": "array"
}
}
},
"source": {
"bucket_id": "bkt_articles",
"type": "bucket"
}
}
],
"pagination": {
"total": 123,
"page": 123,
"page_size": 123,
"total_pages": 123,
"next_page": "<string>",
"previous_page": "<string>",
"next_cursor": "<string>"
},
"total_count": 123,
"stats": {
"total_documents": 0,
"avg_documents_per_collection": 0,
"collections_with_taxonomies": 0,
"total_feature_extractors": 0,
"total_taxonomies": 0,
"total_retrievers": 0
},
"warnings": [
{
"resource": "taxonomy",
"reason": "not found in namespace",
"next_step": "Fix the taxonomy_id on the stage, or create the taxonomy.",
"id": "tax_abc123",
"stage": "<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.
Query Parameters
1 <= x <= 10001 <= x <= 10000 <= x <= 10000x >= 1Body
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.
Request model for listing collections.
Inherits body-level limit/page_size/offset/page — body values win over query pagination via merge_body_pagination.
To filter by taxonomy, use dot notation in filters: filters.AND = [{"field": "taxonomy_applications.taxonomy_id", "operator": "eq", "value": "tax_123"}]
Page size. A body value wins over the limit query param.
1 <= x <= 1000Alias for limit (page size). If both are given, limit wins.
1 <= x <= 1000Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.
0 <= x <= 100001-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.
x >= 1Filters to apply when listing collections. Supports nested field filtering like 'taxonomy_applications.taxonomy_id'. Format: {"AND": [{"field": "field_name", "operator": "eq", "value": "value"}]}
Sort options for the results (single-column, legacy)
Show child attributes
Show child attributes
Sort options as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.
Search term for wildcard search across collection_id, collection_name, description, and other text fields
Include the namespace's system collections: today the per-namespace _direct_upsert default that POST /v1/namespaces/{ns}/documents/upsert writes to (it is also addressable by that name at GET /v1/collections/_direct_upsert). Off by default so the list shows the collections you created.
If True, filters and search will be case-sensitive
Response
Successful Response
Response model for listing collections.
List of collections
Show child attributes
Show child attributes
Pagination information
Show child attributes
Show child attributes
Total number of collections matching the query
Aggregate statistics across all collections in the result
Show child attributes
Show child attributes
Why this page may not be the whole answer. An entry with resource 'namespace' and reason 'unresolved' means X-Namespace did not resolve for this API key, so the empty list is not that namespace's contents (the same condition as the X-Namespace-Unresolved response header). Empty when the namespace resolved.
Show child attributes
Show child attributes
Was this page helpful?

