Skip to main content
GET
/
v1
/
namespaces
/
templates
List Templates
curl --request GET \
  --url https://api.mixpeek.com/v1/namespaces/templates \
  --header 'Authorization: Bearer <token>'
[
  {
    "category": "retail",
    "created_at": "2024-01-15T10:00:00Z",
    "description": "500 products with images and descriptions. Demonstrates visual similarity search and text-based retrieval.",
    "is_active": true,
    "name": "E-commerce Product Catalog",
    "source_namespace_id": "ns_golden_ecommerce",
    "template_id": "tmpl_ecommerce"
  }
]

Authorizations

​
Authorization
string
header
required

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.

Headers

​
Authorization
string
required

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

Examples:

"Bearer sk_live_abc123def456"

"Bearer sk_test_xyz789"

Query Parameters

​
category
string | null

Filter by category

​
is_active
boolean
default:true

Show only active templates

Response

Successful Response

​
template_id
string
required

Unique template identifier. REQUIRED. Use descriptive naming like 'tmpl_ecommerce', 'tmpl_media_search'. Must be unique across all templates. Format: alphanumeric with underscores, starting with 'tmpl_'. Used as primary key in database.

Required string length: 5 - 50
Examples:

"tmpl_ecommerce"

"tmpl_media_library"

"tmpl_document_search"

​
name
string
required

Human-readable template name. REQUIRED. Displayed in UI for template selection. Should be concise but descriptive. Format: Title case, 3-100 characters.

Required string length: 3 - 100
Examples:

"E-commerce Product Catalog"

"Media Library"

"Document Search"

​
description
string
required

Detailed description of template contents and use case. REQUIRED. Explain what data is included, what features are demonstrated, and what the user can do with this template. Shown in template selection UI. Format: 10-500 characters, plain text.

Required string length: 10 - 500
Examples:

"Product catalog with images and descriptions for similarity search"

"Video library with scene detection and semantic search"

"Document repository with text extraction and Q&A capabilities"

​
source_namespace_id
string
required

ID of the golden source namespace to clone from. REQUIRED. Must reference an existing namespace with pre-processed data. The source namespace should be fully configured with collections, documents, and feature stores ready for cloning. Format: namespace ID starting with 'ns_'.

Minimum length: 5
Examples:

"ns_golden_ecommerce"

"ns_template_media"

"ns_demo_docs"

​
category
string
default:general

Template category for organization and filtering. OPTIONAL. Defaults to 'general' if not specified. Common categories: retail, media, finance, healthcare, legal, education. Used for template discovery and filtering in UI. Format: lowercase, alphanumeric.

Examples:

"retail"

"media"

"finance"

"healthcare"

"legal"

"education"

"general"

​
is_active
boolean
default:true

Whether template is available for instantiation. OPTIONAL. Defaults to true. Set to false to hide template from users without deleting it (e.g., for maintenance or deprecation). Inactive templates return 404 when accessed via API.

Examples:

true

false

​
created_at
string<date-time>

Timestamp when template was created. OPTIONAL. Auto-generated if not provided. Format: ISO 8601 datetime in UTC.