Test taxonomy configuration (validation only)
curl --request POST \
--url https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"batch_size": 1000,
"join_mode": "on_demand",
"source_collection_id": "col_catalog_v2",
"target_collection_id": "col_catalog_enriched_v2",
"taxonomy": {
"config": {
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"retriever_id": "ret_clip_v1",
"source_collection": {
"collection_id": "col_products_v1"
},
"taxonomy_type": "flat"
},
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"namespace_id": "ns_123",
"retriever_id": "ret_clip_v1",
"taxonomy_name": "product_tags"
}
}
'import requests
url = "https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute"
payload = {
"batch_size": 1000,
"join_mode": "on_demand",
"source_collection_id": "col_catalog_v2",
"target_collection_id": "col_catalog_enriched_v2",
"taxonomy": {
"config": {
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"retriever_id": "ret_clip_v1",
"source_collection": { "collection_id": "col_products_v1" },
"taxonomy_type": "flat"
},
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"namespace_id": "ns_123",
"retriever_id": "ret_clip_v1",
"taxonomy_name": "product_tags"
}
}
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({
batch_size: 1000,
join_mode: 'on_demand',
source_collection_id: 'col_catalog_v2',
target_collection_id: 'col_catalog_enriched_v2',
taxonomy: {
config: {
input_mappings: [{input_key: 'image_vector', path: 'features.clip', source_type: 'vector'}],
retriever_id: 'ret_clip_v1',
source_collection: {collection_id: 'col_products_v1'},
taxonomy_type: 'flat'
},
input_mappings: [{input_key: 'image_vector', path: 'features.clip', source_type: 'vector'}],
namespace_id: 'ns_123',
retriever_id: 'ret_clip_v1',
taxonomy_name: 'product_tags'
}
})
};
fetch('https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute', 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/taxonomies/{taxonomy_identifier}/execute",
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([
'batch_size' => 1000,
'join_mode' => 'on_demand',
'source_collection_id' => 'col_catalog_v2',
'target_collection_id' => 'col_catalog_enriched_v2',
'taxonomy' => [
'config' => [
'input_mappings' => [
[
'input_key' => 'image_vector',
'path' => 'features.clip',
'source_type' => 'vector'
]
],
'retriever_id' => 'ret_clip_v1',
'source_collection' => [
'collection_id' => 'col_products_v1'
],
'taxonomy_type' => 'flat'
],
'input_mappings' => [
[
'input_key' => 'image_vector',
'path' => 'features.clip',
'source_type' => 'vector'
]
],
'namespace_id' => 'ns_123',
'retriever_id' => 'ret_clip_v1',
'taxonomy_name' => 'product_tags'
]
]),
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/taxonomies/{taxonomy_identifier}/execute"
payload := strings.NewReader("{\n \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\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/taxonomies/{taxonomy_identifier}/execute")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute")
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 \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stats": {
"processed_docs": 0,
"batches": 0,
"errors": 0,
"enriched": 0
},
"results": [
{}
],
"matches": [
{
"document_id": "<string>",
"taxonomy_id": "<string>",
"taxonomy_name": "<string>",
"node_id": "<string>",
"label": "<string>",
"score": 123,
"path": [
"<string>"
],
"hierarchy_level": 123,
"enriched_fields": [
"<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
}Taxonomies
Test taxonomy configuration (validation only)
⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!
POST
/
v1
/
taxonomies
/
{taxonomy_identifier}
/
execute
Test taxonomy configuration (validation only)
curl --request POST \
--url https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"batch_size": 1000,
"join_mode": "on_demand",
"source_collection_id": "col_catalog_v2",
"target_collection_id": "col_catalog_enriched_v2",
"taxonomy": {
"config": {
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"retriever_id": "ret_clip_v1",
"source_collection": {
"collection_id": "col_products_v1"
},
"taxonomy_type": "flat"
},
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"namespace_id": "ns_123",
"retriever_id": "ret_clip_v1",
"taxonomy_name": "product_tags"
}
}
'import requests
url = "https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute"
payload = {
"batch_size": 1000,
"join_mode": "on_demand",
"source_collection_id": "col_catalog_v2",
"target_collection_id": "col_catalog_enriched_v2",
"taxonomy": {
"config": {
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"retriever_id": "ret_clip_v1",
"source_collection": { "collection_id": "col_products_v1" },
"taxonomy_type": "flat"
},
"input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip",
"source_type": "vector"
}
],
"namespace_id": "ns_123",
"retriever_id": "ret_clip_v1",
"taxonomy_name": "product_tags"
}
}
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({
batch_size: 1000,
join_mode: 'on_demand',
source_collection_id: 'col_catalog_v2',
target_collection_id: 'col_catalog_enriched_v2',
taxonomy: {
config: {
input_mappings: [{input_key: 'image_vector', path: 'features.clip', source_type: 'vector'}],
retriever_id: 'ret_clip_v1',
source_collection: {collection_id: 'col_products_v1'},
taxonomy_type: 'flat'
},
input_mappings: [{input_key: 'image_vector', path: 'features.clip', source_type: 'vector'}],
namespace_id: 'ns_123',
retriever_id: 'ret_clip_v1',
taxonomy_name: 'product_tags'
}
})
};
fetch('https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute', 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/taxonomies/{taxonomy_identifier}/execute",
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([
'batch_size' => 1000,
'join_mode' => 'on_demand',
'source_collection_id' => 'col_catalog_v2',
'target_collection_id' => 'col_catalog_enriched_v2',
'taxonomy' => [
'config' => [
'input_mappings' => [
[
'input_key' => 'image_vector',
'path' => 'features.clip',
'source_type' => 'vector'
]
],
'retriever_id' => 'ret_clip_v1',
'source_collection' => [
'collection_id' => 'col_products_v1'
],
'taxonomy_type' => 'flat'
],
'input_mappings' => [
[
'input_key' => 'image_vector',
'path' => 'features.clip',
'source_type' => 'vector'
]
],
'namespace_id' => 'ns_123',
'retriever_id' => 'ret_clip_v1',
'taxonomy_name' => 'product_tags'
]
]),
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/taxonomies/{taxonomy_identifier}/execute"
payload := strings.NewReader("{\n \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\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/taxonomies/{taxonomy_identifier}/execute")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier}/execute")
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 \"batch_size\": 1000,\n \"join_mode\": \"on_demand\",\n \"source_collection_id\": \"col_catalog_v2\",\n \"target_collection_id\": \"col_catalog_enriched_v2\",\n \"taxonomy\": {\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\"\n },\n \"taxonomy_type\": \"flat\"\n },\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip\",\n \"source_type\": \"vector\"\n }\n ],\n \"namespace_id\": \"ns_123\",\n \"retriever_id\": \"ret_clip_v1\",\n \"taxonomy_name\": \"product_tags\"\n }\n}"
response = http.request(request)
puts response.read_body{
"stats": {
"processed_docs": 0,
"batches": 0,
"errors": 0,
"enriched": 0
},
"results": [
{}
],
"matches": [
{
"document_id": "<string>",
"taxonomy_id": "<string>",
"taxonomy_name": "<string>",
"node_id": "<string>",
"label": "<string>",
"score": 123,
"path": [
"<string>"
],
"hierarchy_level": 123,
"enriched_fields": [
"<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
Taxonomy ID or name to validate
Query Parameters
Optional taxonomy version (defaults to latest)
Body
application/json
- ExecuteTaxonomyRequest
- Payload
Request model for on-demand taxonomy validation and testing ONLY.
⚠️ IMPORTANT: This endpoint is ONLY for testing taxonomy configuration with sample documents.
DO NOT USE THIS FOR BATCH ENRICHMENT: ❌ Do NOT use this to enrich an entire collection ❌ Do NOT use source_collection_id expecting batch processing ❌ Do NOT use target_collection_id expecting persistence
HOW TAXONOMY ENRICHMENT ACTUALLY WORKS:
✅ Automatic during ingestion: Attach taxonomies to collections via taxonomy_applications
✅ On-the-fly in retrieval: Add taxonomy_join stage to retriever pipelines
This endpoint validates:
- Taxonomy configuration is correct
- Retriever can find matching taxonomy nodes
- Enrichment fields are properly applied
For production enrichment, see:
- Collections API: attach taxonomies via
taxonomy_applicationsfield - Retrievers API: add
taxonomy_joinstage for on-the-fly enrichment
Full taxonomy model with configuration (fetched from DB by controller)
Show child attributes
Show child attributes
Examples:
{
"config": {
"default_input_mappings": [
{
"input_key": "image_vector",
"path": "features.clip_vit_l_14",
"source_type": "vector"
}
],
"default_retriever_id": "ret_clip_v1",
"source_collection": { "collection_id": "col_products_v1" },
"taxonomy_type": "flat"
},
"namespace_id": "ns_123",
"taxonomy_name": "product_tags",
"taxonomy_type": "flat"
}
{
"config": {
"build_mode": "explicit",
"default_input_mappings": [
{
"input_key": "face_vec",
"path": "features.face",
"source_type": "vector"
}
],
"default_retriever_id": "ret_face_v1",
"hierarchical_nodes": [
{ "collection_id": "col_employees_v1" },
{
"collection_id": "col_executives_v1",
"parent_collection_id": "col_employees_v1"
}
],
"taxonomy_type": "hierarchical"
},
"namespace_id": "ns_123",
"taxonomy_name": "org_hierarchy",
"taxonomy_type": "hierarchical"
}
Optional retriever configuration override for testing. If omitted, uses the retriever configured in the taxonomy.
Show child attributes
Show child attributes
Sample documents to test enrichment (typically 1-5 docs). Results are returned immediately, not persisted. ⚠️ Do NOT pass collection_id expecting batch processing!
⚠️ IGNORED IN ON_DEMAND MODE. This field exists for legacy compatibility only. To enrich collections, use taxonomy_applications on the collection.
⚠️ IGNORED IN ON_DEMAND MODE. This field exists for legacy compatibility only. Results are never persisted via this endpoint.
Must be 'on_demand'. BATCH mode is NOT supported via API. Batch enrichment is automatic (triggered by engine during ingestion).
Available options:
on_demand, batch Batch size for the scroll iterator
Required range:
1 <= x <= 10000Additional filters applied to the source collection prior to enrichment.
Show child attributes
Show child attributes
Response
Successful Response
Show child attributes
Show child attributes
Flattened per-document match summaries extracted from processing_history — convenience for clients so they don't have to spelunk metadata.processing_history.
Show child attributes
Show child attributes
Was this page helpful?