POST
/
v1
/
taxonomies
curl --request POST \
  --url https://api.mixpeek.com/v1/taxonomies \
  --header 'Content-Type: application/json' \
  --data '{
  "taxonomy_name": "<string>",
  "description": "<string>",
  "config": {
    "source_collections": [
      {
        "collection_id": "<string>",
        "enrichment_fields": [
          {
            "field_name": "<string>",
            "append": false
          }
        ],
        "retriever": {
          "retriever_id": "<string>",
          "inputs": {}
        }
      }
    ]
  }
}'
{
  "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.

Body

application/json

Request to create a new taxonomy

​
taxonomy_name
string
required
​
config
object
required

Base configuration for all taxonomy types

​
description
string | null

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,
CONVERTING
​
inputs
any[] | null
​
outputs
any[] | null

Was this page helpful?

Suggest editsRaise issue