Health
Entities
Assets
Collections
Namespaces
Feature Extractors
Update Taxonomy
Update an existing taxonomy’s metadata
Requirements:
- Required permissions: write
curl --request PATCH \
--url https://api.mixpeek.com/v1/entities/taxonomies/{taxonomy} \
--header 'Content-Type: application/json' \
--data '{
"taxonomy_name": "electronics_updated",
"description": "Updated electronics taxonomy"
}'{
"taxonomy_id": "tax_abc123xyz",
"taxonomy_name": "electronics",
"nodes": [
{
"children": [],
"embedding_configs": [
{
"embedding_model": "text",
"type": "text",
"value": "electronics accessories"
}
],
"node_description": "Electronics accessories and peripherals category",
"node_id": "node_abc123def456gh",
"node_name": "electronics_accessories",
"path_tokens": [
"electronics_accessories"
]
}
]
}Headers
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'
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
The ID or name of the taxonomy to update
Body
Model for updating specific taxonomy fields
Updated taxonomy name (must not contain spaces or special characters)
Updated taxonomy description
Response
Taxonomy name
Taxonomy nodes
ID of the taxonomy this node belongs to
Name of the taxonomy node (must be lowercase without spaces)
List of embedding configurations defining how this node should be vectorized
Type of the input
text, url, base64 Value of the input
Name of the embedding model to use
image, multimodal, text, video, keyword, naver-splade-v3, vertex-multimodal, openai-clip-vit-base-patch32, baai-bge-m3 Unique identifier for the taxonomy node
ID of the parent node (None if root node)
Optional description of what this node represents
List of child nodes under this node
ID of the taxonomy this node belongs to
Name of the taxonomy node (must be lowercase without spaces)
List of embedding configurations defining how this node should be vectorized
Type of the input
text, url, base64 Value of the input
Name of the embedding model to use
image, multimodal, text, video, keyword, naver-splade-v3, vertex-multimodal, openai-clip-vit-base-patch32, baai-bge-m3 Unique identifier for the taxonomy node
ID of the parent node (None if root node)
Optional description of what this node represents
List of child nodes under this node
ID of the taxonomy this node belongs to
Name of the taxonomy node (must be lowercase without spaces)
List of embedding configurations defining how this node should be vectorized
Type of the input
text, url, base64 Value of the input
Name of the embedding model to use
image, multimodal, text, video, keyword, naver-splade-v3, vertex-multimodal, openai-clip-vit-base-patch32, baai-bge-m3 Unique identifier for the taxonomy node
ID of the parent node (None if root node)
Optional description of what this node represents
List of child nodes under this node
ID of the taxonomy this node belongs to
Name of the taxonomy node (must be lowercase without spaces)
List of embedding configurations defining how this node should be vectorized
Unique identifier for the taxonomy node
ID of the parent node (None if root node)
Optional description of what this node represents
List of child nodes under this node
List of node names representing the path from root to this node
Order of the node in the taxonomy
Depth of the node in the taxonomy
List of node names representing the path from root to this node
Order of the node in the taxonomy
Depth of the node in the taxonomy
List of node names representing the path from root to this node
Order of the node in the taxonomy
Depth of the node in the taxonomy
List of node names representing the path from root to this node
Order of the node in the taxonomy
Depth of the node in the taxonomy
Auto-generated taxonomy identifier
Was this page helpful?
curl --request PATCH \
--url https://api.mixpeek.com/v1/entities/taxonomies/{taxonomy} \
--header 'Content-Type: application/json' \
--data '{
"taxonomy_name": "electronics_updated",
"description": "Updated electronics taxonomy"
}'{
"taxonomy_id": "tax_abc123xyz",
"taxonomy_name": "electronics",
"nodes": [
{
"children": [],
"embedding_configs": [
{
"embedding_model": "text",
"type": "text",
"value": "electronics accessories"
}
],
"node_description": "Electronics accessories and peripherals category",
"node_id": "node_abc123def456gh",
"node_name": "electronics_accessories",
"path_tokens": [
"electronics_accessories"
]
}
]
}