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 '
{
  "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"
  },
  "description": "<string>"
}
'

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

POST

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 '
{
  "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"
  },
  "description": "<string>"
}
'

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

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

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

Body

application/json

Request model to create 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.

FlatTaxonomyConfig
HierarchicalTaxonomyConfig

Show child attributes

config.retriever_id

string

required

The retriever to use for matching against the source collection.

config.input_mappings

InputMapping · object[]

required

Input mappings defining how to construct retriever inputs.

Show child attributes

config.input_mappings.input_key

string

required

Key used in the constructed inputs payload.

config.input_mappings.source_type

enum<string> | null

Source of the value (payload, literal, vector).

Available options:

payload,

literal,

vector

config.input_mappings.path

string | null

Dot-notation path inside payload/vector when source_type is PAYLOAD or VECTOR.

config.input_mappings.override

any | null

Static value used when source_type is LITERAL. Overrides any path.

config.source_collection

SourceCollection · object

required

The single source collection for this flat taxonomy.

Show child attributes

config.source_collection.collection_id

string

required

The ID of the source collection for the taxonomy.

config.source_collection.enrichment_fields

EnrichmentField · object[] | null

Fields to copy from matched taxonomy node when enriching (append/replace semantics). If omitted, the full payload is copied.

Show child attributes

config.source_collection.enrichment_fields.field_path

string

required

Dot-notation path of the field to copy from the taxonomy node.

config.source_collection.enrichment_fields.target_field

string | null

Optional target field name in the enriched document. If specified, the source field will be renamed to this name. If not specified, the field_path is used as the target name. Use this to rename fields during enrichment (e.g., label → visual_style).

Example:

"visual_style"

config.source_collection.enrichment_fields.merge_mode

enum<string>

default:replace

Whether to overwrite the target's value or append (for arrays).

Available options:

replace,

append

config.taxonomy_type

string

default:flat

Discriminator identifying this as a flat taxonomy.

Allowed value: "flat"

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

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

FlatTaxonomyConfig · object

required

Configuration specific to the taxonomy type.

FlatTaxonomyConfig
HierarchicalTaxonomyConfig

Show child attributes

config.retriever_id

string

required

The retriever to use for matching against the source collection.

config.input_mappings

InputMapping · object[]

required

Input mappings defining how to construct retriever inputs.

Show child attributes

config.input_mappings.input_key

string

required

Key used in the constructed inputs payload.

config.input_mappings.source_type

enum<string> | null

Source of the value (payload, literal, vector).

Available options:

payload,

literal,

vector

config.input_mappings.path

string | null

Dot-notation path inside payload/vector when source_type is PAYLOAD or VECTOR.

config.input_mappings.override

any | null

Static value used when source_type is LITERAL. Overrides any path.

config.source_collection

SourceCollection · object

required

The single source collection for this flat taxonomy.

Show child attributes

config.source_collection.collection_id

string

required

The ID of the source collection for the taxonomy.

config.source_collection.enrichment_fields

EnrichmentField · object[] | null

Fields to copy from matched taxonomy node when enriching (append/replace semantics). If omitted, the full payload is copied.

Show child attributes

config.source_collection.enrichment_fields.field_path

string

required

Dot-notation path of the field to copy from the taxonomy node.

config.source_collection.enrichment_fields.target_field

string | null

Example:

"visual_style"

config.source_collection.enrichment_fields.merge_mode

enum<string>

default:replace

Whether to overwrite the target's value or append (for arrays).

Available options:

replace,

append

config.taxonomy_type

string

default:flat

Discriminator identifying this as a flat taxonomy.

Allowed value: "flat"

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

input_mappings.input_key

string

required

Key used in the constructed inputs payload.

input_mappings.source_type

enum<string> | null

Source of the value (payload, literal, vector).

Available options:

payload,

literal,

vector

input_mappings.path

string | null

Dot-notation path inside payload/vector when source_type is PAYLOAD or VECTOR.

input_mappings.override

any | null

Static value used when source_type is LITERAL. Overrides any path.

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

Start retriever evaluation task Get Taxonomy

⌘I

Health

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Analytics

Tasks

Webhooks

Create Taxonomy

Authorizations

Headers

Body

Response