Skip to main content
PATCH
/
v1
/
taxonomies
/
{taxonomy_identifier}
Partially Update Taxonomy
curl --request PATCH \
  --url https://api.mixpeek.com/v1/taxonomies/{taxonomy_identifier} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '
{
  "taxonomy_name": "<string>",
  "description": "<string>",
  "metadata": {}
}
'
{
  "taxonomy_name": "<string>",
  "config": {
    "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>",
  "version": 1,
  "description": "<string>",
  "retriever_id": "<string>",
  "input_mappings": [
    {
      "input_key": "<string>",
      "source_type": "payload",
      "path": "<string>",
      "override": "<unknown>"
    }
  ],
  "ready": true,
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

Headers

​
Authorization
string
required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string
required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

​
taxonomy_identifier
string
required

Taxonomy ID or name

Body

application/json

Request model for partially updating a taxonomy (PATCH operation).

​
taxonomy_name
string | null

Updated name for the taxonomy

​
description
string | null

Updated description for the taxonomy

​
metadata
Metadata · object

Updated metadata for the taxonomy

Response

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 specific to the taxonomy type.

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).

​
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