POST
/
v1
/
entities
/
taxonomies
/
{taxonomy}
/
classifications
curl --request POST \
  --url https://api.mixpeek.com/v1/entities/taxonomies/{taxonomy}/classifications \
  --header 'Content-Type: application/json' \
  --data '{
  "filters": {
    "AND": [
      {
        "key": "score",
        "operator": "gte",
        "value": 0.8
      },
      {
        "key": "node_name",
        "operator": "contains",
        "value": "electronics"
      }
    ]
  },
  "sort": {
    "direction": "desc",
    "field": "created_at"
  },
  "feature_options": {
    "return_payload": true,
    "return_url": true
  },
  "node_options": {
    "return_payload": true
  }
}'
{
  "results": [
    {
      "feature_id": "<string>",
      "feature": {
        "url": "<string>",
        "preview_url": "<string>",
        "duplicate_of": "<string>"
      },
      "classification_id": "<string>",
      "taxonomy_id": "<string>",
      "matches": [
        {
          "taxonomy_id": "<string>",
          "node_id": "<string>",
          "node": {
            "node_id": "node_abc123def456gh",
            "taxonomy_id": "tax_xyz789",
            "parent_node_id": "node_123abc456def",
            "node_name": "electronics_accessories",
            "node_description": "Electronics accessories and peripherals category",
            "children": [
              {}
            ],
            "path_tokens": [
              "electronics",
              "accessories",
              "cables"
            ],
            "embedding_configs": [
              {
                "embedding_model": "text",
                "type": "text",
                "value": "electronics accessories"
              }
            ],
            "order": [
              1,
              2,
              3
            ],
            "depth": 1
          },
          "score": 0.5,
          "depth": 1,
          "order": [
            1,
            2,
            3
          ]
        }
      ]
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "page_size": 123,
    "total_pages": 123,
    "next_page": "<string>",
    "previous_page": "<string>"
  }
}

Headers

​
Authorization
string | null

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. Example: 'Bearer sk_1234567890abcdef'

​
X-Namespace
string | null

Optional namespace for data isolation. This can be a namespace name or namespace ID. Example: 'netflix_prod' or 'ns_1234567890'. To create a namespace, use the /namespaces endpoint.

Path Parameters

​
taxonomy
string
required

The ID or name of the taxonomy

Query Parameters

​
page
integer | null
default:
1
​
page_size
integer
default:
10

Body

application/json

Request model for listing classifications with filters

​
filters
object | null

Complex nested query filters for classifications

​
sort
object | null

Sort options for ordering classifications

​
feature_options
object | null

Controls what feature data to include in the response. Note: Including additional data increases response latency.

​
node_options
object | null

Controls what node data to include in the response. Note: Including additional data increases response latency.

Response

200
application/json
Successful Response

Response for the list classifications endpoint

​
results
object[]
required

List of classification entries with optional enriched data

Classification entry with optional full feature and node data

​
pagination
object
required

Pagination information

Was this page helpful?

Suggest editsRaise issue
Classify Features against TaxonomyDelete Classifications