Partially Update Taxonomy

Update a taxonomy’s metadata.

Metadata Only Updates: This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable to ensure consistency for join history and dependent resources.

Fields You CAN Update:

• taxonomy_name: Rename the taxonomy
• description: Update documentation
• metadata: Update custom metadata

Fields You CANNOT Update:

• config: Taxonomy configuration (retriever_id, input_mappings, collections)
• taxonomy_type: Type (flat vs hierarchical)

Need to Modify Core Logic? Use POST //clone instead to modify configuration, retriever_id, input_mappings, or collections.

PATCH /v1/taxonomies/{taxonomy_identifier}

Partially Update Taxonomy

cURL

curl --request PATCH \
  --url https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '
{
  "taxonomy_name": "<string>",
  "description": "<string>",
  "metadata": {}
}
'

200

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

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 header returns 403; an invalid or revoked key returns 401.

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

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.

Request to update a taxonomy's metadata.

IMPORTANT: Partial Updates with Controlled Mutability

This endpoint allows updating ONLY metadata fields. Core taxonomy logic is immutable to ensure consistency for join history and dependent resources.

✅ Fields You CAN Update (Metadata Only):

• taxonomy_name: Rename the taxonomy
• description: Update documentation
• metadata: Update custom metadata fields

❌ Fields You CANNOT Update (Immutable Core Logic):

• config: Taxonomy configuration (retriever_id, input_mappings, collections, hierarchy)
• taxonomy_type: Type (flat vs hierarchical)
• retriever_id: Associated retriever
• input_mappings: Field mappings
• enrichment_fields: Enrichment configuration

Need to Modify Core Logic? Use POST /taxonomies/{taxonomy_id}/clone instead. Cloning creates a new taxonomy with a new ID, allowing you to:

• Change retriever or input mappings
• Modify enrichment fields
• Update collection configuration
• Change taxonomy hierarchy

Behavior:

• All fields are OPTIONAL - provide only what you want to update
• Empty updates (no fields provided) will be rejected with 400 error
• Original taxonomy remains unchanged (no destructive operations)

Why This Design?

• Join history is tied to specific taxonomy configuration
• Changing retriever would invalidate previous joins
• Version tracking enables auditing and rollback

taxonomy_name · string | null

Updated name for the taxonomy

description · string | null

Updated description for the taxonomy

metadata · Metadata · object | null

Updated metadata for the taxonomy

Response

200

application/json

Successful Response

Response model for a taxonomy.

taxonomy_name · string · required

A unique name for the taxonomy within the namespace.

config · FlatTaxonomyConfig · object · required

Configuration for a flat taxonomy - single source collection with one retriever.

FlatTaxonomyConfig

HierarchicalTaxonomyConfig

Show child attributes

Example:

{
  "input_mappings": [
    {
      "input_key": "image_vector",
      "path": "features.clip_vit_l_14",
      "source_type": "vector"
    }
  ],
  "retriever_id": "ret_clip_v1",
  "source_collection": {
    "collection_id": "col_products_v1",
    "enrichment_fields": [
      {
        "field_path": "metadata.tags",
        "merge_mode": "append"
      }
    ]
  },
  "taxonomy_type": "flat"
}

taxonomy_id · string

Unique identifier for the taxonomy

version · integer · default: 1

Monotonic version number of the taxonomy configuration

Required range: x >= 1

description · string | null

Optional human-readable description.

retriever_id · string | null

Optional taxonomy-level retriever (prefer per-layer).

input_mappings · InputMapping · object[] | null

Optional taxonomy-level inputs (prefer per-layer).

Show child attributes

nodes · TaxonomyPathNode · object[] | null

For a hierarchy built from config.path_field: one node per distinct path prefix seen in enriched documents, with its parent. Grows as enrichment meets new paths. None for other taxonomies.

Show child attributes

ready · boolean · default: true

Whether the taxonomy is ready for use. False for async inference (cluster/LLM) that needs processing. True for flat/explicit hierarchies.

created_at · string<date-time>

Creation timestamp for this taxonomy record

metadata · Metadata · object

Additional user-defined metadata for the taxonomy