Skip to main content
GET
/
v1
/
templates
/
taxonomies
/
{template_id}
Get Taxonomy Template
curl --request GET \
  --url https://api.mixpeek.com/v1/templates/taxonomies/{template_id}
{
  "template_id": "<string>",
  "template_type": "namespace",
  "scope": "system",
  "internal_id": "<string>",
  "name": "<string>",
  "description": "<string>",
  "configuration": {},
  "category": "<string>",
  "tags": [
    "<string>"
  ],
  "is_active": true,
  "is_public": false,
  "use_cases": [
    "<string>"
  ],
  "requirements": [
    "<string>"
  ],
  "created_by": "<string>",
  "source_resource_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

​
template_id
string
required

Template ID

Response

Successful Response

Base template model with common fields for all template types.

This model is stored in MongoDB and supports three template scopes:

  • System: Mixpeek defaults (all orgs)
  • Organization: All users in the org
  • User: Only the creator
​
template_id
string
required

Unique template identifier (e.g., 'tmpl_semantic_search')

​
template_type
enum<string>
required

Type of resource this template creates

Available options:
namespace,
retriever,
cluster,
collection,
bucket,
taxonomy
​
scope
enum<string>
required

Template scope (system or organization)

Available options:
system,
organization,
user
​
internal_id
string
required

Organization internal ID. For system templates, use 'system'. For org templates, use the actual internal_id.

​
name
string
required

Human-readable template name

Required string length: 1 - 100
​
description
string
required

Detailed description of the template's purpose

Required string length: 1 - 1000
​
configuration
Configuration · object
required

Template-specific configuration (varies by template_type)

​
category
string | null

Optional category for organizing templates

​
tags
string[]

Tags for categorizing and filtering templates

​
is_active
boolean
default:true

Whether this template is available for use

​
is_public
boolean
default:false

Whether this template is publicly discoverable without authentication

​
use_cases
string[]

List of common use cases for this template

​
requirements
string[]

List of requirements (e.g., 'Requires text embeddings')

​
created_by
string | null

User ID who created this template (for org templates)

​
source_resource_id
string | null

ID of the resource this template was created from (for org templates)

​
created_at
string<date-time>

Timestamp when template was created

​
updated_at
string<date-time>

Timestamp when template was last updated