Skip to main content
POST
/
v1
/
taxonomies
Create Taxonomy
curl --request POST \
  --url https://api.mixpeek.com/v1/taxonomies \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Namespace: <x-namespace>' \
  --data '{
  "config": {
    "collection_id": "col_products_v1",
    "enrichment_fields": [
      {
        "field_path": "metadata.tags",
        "merge_mode": "append"
      }
    ],
    "input_mappings": [
      {
        "input_key": "image_vector",
        "path": "features.clip",
        "source_type": "vector"
      }
    ],
    "retriever_id": "ret_clip_v1",
    "taxonomy_type": "flat"
  },
  "taxonomy_name": "product_tags"
}'
{
  "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

Bearer token authentication using your API key. Format: 'Bearer your_api_key'. To get an API key, create an account at mixpeek.com/start and generate a key in your account settings.

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.

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

​
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'

Examples:

"ns_abc123def456"

"production"

"my-namespace"

Body

application/json

Request model to create a taxonomy.

​
taxonomy_name
string
required

A unique name for the taxonomy within the namespace.

​
config
object
required

Configuration specific to the taxonomy type. Configuration for a flat taxonomy - single source collection with one retriever.

  • FlatTaxonomyConfig
  • HierarchicalTaxonomyConfig
Examples:
{
  "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"
}
​
description
string | null

An optional description of the taxonomy.

Response

Successful Response

Response model for a taxonomy.

​
taxonomy_name
string
required

A unique name for the taxonomy within the namespace.

​
config
object
required

Configuration specific to the taxonomy type. Configuration for a flat taxonomy - single source collection with one retriever.

  • FlatTaxonomyConfig
  • HierarchicalTaxonomyConfig
Examples:
{
  "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
object

Additional user-defined metadata for the taxonomy