Test taxonomy configuration (validation only)

⚠️ VALIDATION ENDPOINT ONLY - Not for production enrichment!

POST /v1/taxonomies/{taxonomy_identifier}/execute

Test taxonomy configuration (validation only)

cURL

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"
  }
}
'

200

{
  "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>"
      ]
    }
  ]
}

Authorizations

Authorization · string · header · required

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.

X-Namespace · string · header · required

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_identifier · string · required

Taxonomy ID or name to validate

Query Parameters

version · integer | null

Optional taxonomy version (defaults to latest)

Body

application/json

Keys this body does not declare are refused with 422 extra_forbidden naming the accepted keys (since 2026-11-02).

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_applications field
• Retrievers API: add taxonomy_join stage for on-the-fly enrichment

taxonomy · TaxonomyModel · object · required

Full taxonomy model with configuration (fetched from DB by controller)

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"
}

retriever · RetrieverModel · object | null

Optional retriever configuration override for testing. If omitted, uses the retriever configured in the taxonomy.

Show child attributes

source_documents · Source Documents · object[] | null

Sample documents to test enrichment (typically 1-5 docs). Results are returned immediately, not persisted. ⚠️ Do NOT pass collection_id expecting batch processing!

source_collection_id · string | null

⚠️ IGNORED IN ON_DEMAND MODE. This field exists for legacy compatibility only. To enrich collections, use taxonomy_applications on the collection.

target_collection_id · string | null

⚠️ IGNORED IN ON_DEMAND MODE. This field exists for legacy compatibility only. Results are never persisted via this endpoint.

join_mode · enum<string> · default: on_demand

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 · integer · default: 1000

Batch size for the scroll iterator

Required range: 1 <= x <= 10000

scroll_filters · LogicalOperator · object | null

Additional filters applied to the source collection prior to enrichment.

Show child attributes

Response

200

application/json

Successful Response

stats · JoinStats · object · required

Show child attributes

results · Results · object[] | null

matches · TaxonomyMatch · object[] | null

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