Skip to main content
POST
Create Taxonomy

Authorizations

Authorization
string
header
required

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

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 for a flat taxonomy - single source collection with one retriever.

Example:
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 for a flat taxonomy - single source collection with one retriever.

Example:
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