Create Taxonomy
curl --request POST \
--url https://api.mixpeek.com/v1/taxonomies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"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"
},
"description": "<string>"
}
'import requests
url = "https://api.mixpeek.com/v1/taxonomies"
payload = {
"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"
},
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
},
description: '<string>'
})
};
fetch('https://api.mixpeek.com/v1/taxonomies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/taxonomies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/taxonomies"
payload := strings.NewReader("{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/taxonomies")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/taxonomies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"path": "<string>",
"override": "<unknown>"
}
],
"ready": true,
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Taxonomies
Create Taxonomy
Create a taxonomy and return the created resource.
POST
/
v1
/
taxonomies
Create Taxonomy
curl --request POST \
--url https://api.mixpeek.com/v1/taxonomies \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Namespace: <api-key>' \
--data '
{
"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"
},
"description": "<string>"
}
'import requests
url = "https://api.mixpeek.com/v1/taxonomies"
payload = {
"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"
},
"description": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"X-Namespace": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
Authorization: 'Bearer <token>',
'X-Namespace': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
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'
},
description: '<string>'
})
};
fetch('https://api.mixpeek.com/v1/taxonomies', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.mixpeek.com/v1/taxonomies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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'
],
'description' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Namespace: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.mixpeek.com/v1/taxonomies"
payload := strings.NewReader("{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("X-Namespace", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.mixpeek.com/v1/taxonomies")
.header("Authorization", "Bearer <token>")
.header("X-Namespace", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.mixpeek.com/v1/taxonomies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Namespace"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"taxonomy_name\": \"<string>\",\n \"config\": {\n \"input_mappings\": [\n {\n \"input_key\": \"image_vector\",\n \"path\": \"features.clip_vit_l_14\",\n \"source_type\": \"vector\"\n }\n ],\n \"retriever_id\": \"ret_clip_v1\",\n \"source_collection\": {\n \"collection_id\": \"col_products_v1\",\n \"enrichment_fields\": [\n {\n \"field_path\": \"metadata.tags\",\n \"merge_mode\": \"append\"\n }\n ]\n },\n \"taxonomy_type\": \"flat\"\n },\n \"description\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"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>",
"path": "<string>",
"override": "<unknown>"
}
],
"ready": true,
"created_at": "2023-11-07T05:31:56Z",
"metadata": {}
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}{
"status": 123,
"error": {
"message": "<string>",
"type": "<string>",
"code": "<string>",
"details": {}
},
"success": false
}Authorizations
Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.
Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.
Body
application/json
Request model to create a taxonomy.
A unique name for the taxonomy within the namespace.
Configuration for a flat taxonomy - single source collection with one retriever.
- FlatTaxonomyConfig
- HierarchicalTaxonomyConfig
Show child attributes
Show child attributes
Example:
{
"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"
}
An optional description of the taxonomy.
Response
Successful Response
Response model for a taxonomy.
A unique name for the taxonomy within the namespace.
Configuration for a flat taxonomy - single source collection with one retriever.
- FlatTaxonomyConfig
- HierarchicalTaxonomyConfig
Show child attributes
Show child attributes
Example:
{
"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"
}
Unique identifier for the taxonomy
Monotonic version number of the taxonomy configuration
Required range:
x >= 1Optional human-readable description.
Optional taxonomy-level retriever (prefer per-layer).
Optional taxonomy-level inputs (prefer per-layer).
Show child attributes
Show child attributes
Whether the taxonomy is ready for use. False for async inference (cluster/LLM) that needs processing. True for flat/explicit hierarchies.
Creation timestamp for this taxonomy record
Additional user-defined metadata for the taxonomy
Was this page helpful?
⌘I