curl --request POST \
--url https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"sample_size": 1000,
"force": false,
"cascade_to_downstream": true
}
'import requests
url = "https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema"
payload = {
"sample_size": 1000,
"force": False,
"cascade_to_downstream": True
}
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({sample_size: 1000, force: false, cascade_to_downstream: true})
};
fetch('https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema', 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/{collection_id}/sync-schema",
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([
'sample_size' => 1000,
'force' => false,
'cascade_to_downstream' => true
]),
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/{collection_id}/sync-schema"
payload := strings.NewReader("{\n \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\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/{collection_id}/sync-schema")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema")
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 \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"collection_id": "<string>",
"schema_version": 123,
"previous_version": 123,
"fields_total": 123,
"documents_sampled": 123,
"fields_added": [
"<string>"
],
"downstream_collections_updated": [
"<string>"
],
"message": "<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
}{
"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
}Sync Collection Schema
Sample documents from the vector store and automatically discover new fields to add to the collection’s output_schema.
This endpoint:
- Samples N documents from the collection (default: 1000)
- Discovers all fields present in actual documents
- Merges discovered fields into the collection’s output_schema (additive only)
- Optionally cascades schema updates to downstream collections
- Respects debounce window (max once per 5 minutes, unless force=true)
The sync operation is additive only - it never removes or changes existing field types.
Use this endpoint to:
- Manually trigger schema discovery after data ingestion
- Force an immediate schema sync (bypassing debounce)
- Update schemas with new fields discovered in documents
curl --request POST \
--url https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"sample_size": 1000,
"force": false,
"cascade_to_downstream": true
}
'import requests
url = "https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema"
payload = {
"sample_size": 1000,
"force": False,
"cascade_to_downstream": True
}
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({sample_size: 1000, force: false, cascade_to_downstream: true})
};
fetch('https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema', 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/{collection_id}/sync-schema",
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([
'sample_size' => 1000,
'force' => false,
'cascade_to_downstream' => true
]),
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/{collection_id}/sync-schema"
payload := strings.NewReader("{\n \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\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/{collection_id}/sync-schema")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/collections/{collection_id}/sync-schema")
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 \"sample_size\": 1000,\n \"force\": false,\n \"cascade_to_downstream\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"collection_id": "<string>",
"schema_version": 123,
"previous_version": 123,
"fields_total": 123,
"documents_sampled": 123,
"fields_added": [
"<string>"
],
"downstream_collections_updated": [
"<string>"
],
"message": "<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
}{
"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
Collection ID to sync schema for
Body
Request to sync a collection's schema by sampling documents.
Used by:
- Manual API calls from users
- Automatic triggers from BatchJobPoller
Number of documents to sample for schema discovery
1 <= x <= 10000Force schema sync even if within debounce window. Default: false (respects 5-minute debounce)
Automatically update downstream collections that use this collection as source. Default: true
Response
Successful Response
- SchemaSyncResponse
- SchemaSyncSkippedResponse
Response from schema sync operation.
Whether schema sync succeeded
Collection that was synced
New schema version
Previous schema version
Total fields in output_schema
Number of documents sampled
List of new fields discovered
Downstream collections that were updated
Additional message or error
Was this page helpful?

