Create Taxonomy Version

Create a new version for a taxonomy with a new config snapshot.

POST /v1/taxonomies/{taxonomy_id}/versions

Create Taxonomy Version

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/taxonomies/{taxonomy_id}/versions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <api-key>' \
  --data '{}'

200

{
  "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>",
      "path": "<string>",
      "override": "<unknown>"
    }
  ],
  "ready": true,
  "created_at": "2023-11-07T05:31:56Z",
  "metadata": {}
}

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

Taxonomy ID (tax_...)

Body

application/json

The body is of type Body · object.

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

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