POST
/
v1
/
entities
/
taxonomies
/
{taxonomy}
/
classify
curl --request POST \
  --url https://api.mixpeek.com/v1/entities/taxonomies/{taxonomy}/classify \
  --header 'Content-Type: application/json' \
  --data '{
  "collections": [
    "<string>"
  ],
  "filters": {
    "case_sensitive": true,
    "AND": [
      {
        "key": "name",
        "operator": "eq",
        "value": "John"
      },
      {
        "key": "age",
        "operator": "gte",
        "value": 30
      }
    ],
    "OR": [
      {
        "key": "status",
        "operator": "eq",
        "value": "active"
      },
      {
        "key": "role",
        "operator": "eq",
        "value": "admin"
      }
    ],
    "NOR": [
      {
        "key": "department",
        "operator": "eq",
        "value": "HR"
      },
      {
        "key": "location",
        "operator": "eq",
        "value": "remote"
      }
    ]
  },
  "assignment": {
    "enabled": false,
    "mode": "threshold",
    "append": false,
    "confidence_threshold": 0.5
  },
  "limit": 123
}'
{
  "task_id": "<string>",
  "status": "PENDING",
  "inputs": [
    "<any>"
  ],
  "outputs": [
    "<any>"
  ]
}

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 name or id of the taxonomy to use for discovery

Body

application/json
​
collections
string[]
required

List of collection names or ids to search for features

​
filters
object | null

Filters to apply to the discovery task

​
assignment
object

Configuration for feature assignment behavior

​
limit
integer | null
default:
1000

Number of feature samples to process, if None, all features that match the filters are processed

Response

200
application/json
Successful Response
​
task_id
string
required
​
status
enum<string>
Available options:
DONE,
FAILED,
SKIPPED,
CANCELLED,
PROCESSING,
DOWNLOADING,
INITIALIZING,
UPLOADING,
QUEUED,
PENDING
​
inputs
any[] | null
​
outputs
any[] | null

Was this page helpful?

Suggest editsRaise issue
Update NodeList Taxonomy Classifications