Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Taxonomies

List taxonomies (GET alias for POST /list).

List taxonomies with optional filters and pagination.

get/v1/taxonomies

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

limitinteger nullable

Page size. A body value wins over the limit query param.

page_sizeinteger nullable

Alias for limit (page size). If both are given, limit wins.

offsetinteger nullable

Number of results to skip (legacy, use cursor instead). A body value wins over the offset query param.

pageinteger nullable

1-indexed page number. Folds to offset = (page-1) * limit. If both page and offset are given, offset wins.

searchstring nullable

Search term for wildcard search across taxonomy_id, taxonomy_name, description, and other text fields

sortsobject[] nullable

Sort configuration as a list of {field, direction} — the shape Studio datatables and the retriever list send. The first entry is the primary sort. Takes precedence over the singular sort.

case_sensitiveboolean

If True, filters and search will be case-sensitive

Example request

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

Response

Successful Response

paginationobject required
total_countinteger required

Example response

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