Skip to main content
POST
/
v1
/
taxonomies
/
list
List Taxonomies
curl --request POST \
  --url https://api.mixpeek.com/v1/taxonomies/list \
  --header 'Content-Type: application/json' \
  --data '
{
  "search": "<string>",
  "filters": {
    "AND": [
      {
        "field": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "field": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "field": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "field": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOT": [
      {
        "field": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "field": "location",
        "operator": "eq",
        "value": "remote"
      }
    ],
    "case_sensitive": true
  },
  "sort": {
    "field": "created_at",
    "direction": "desc"
  },
  "case_sensitive": false
}
'
{
  "results": [
    {
      "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": {}
    }
  ],
  "pagination": {},
  "total_count": 123,
  "stats": {
    "total_taxonomies": 0,
    "flat_taxonomies": 0,
    "hierarchical_taxonomies": 0,
    "taxonomies_with_retrievers": 0
  }
}

Headers

Authorization
string

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

"Bearer YOUR_STRIPE_API_KEY"

X-Namespace
string

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"

Query Parameters

limit
integer | null
offset
integer | null

Body

application/json

Request model to list taxonomies.

search
string | null

Search term to filter taxonomies by name

filters
LogicalOperator · object

Filters to apply to the taxonomy list

sort
SortOption · object

Sort configuration for the taxonomy list

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response model for listing taxonomies.

results
TaxonomyResponse · object[]
required
pagination
Pagination · object
required
total_count
integer
required
stats
TaxonomyListStats · object

Aggregate statistics across all taxonomies in the result