Authorizations
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
REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.
"Bearer sk_live_abc123def456"
"Bearer sk_test_xyz789"
Body
Namespace template definition.
Templates are pre-configured namespace blueprints that reference a golden source namespace containing pre-processed data. Users can instantiate templates to quickly create fully-functional namespaces without manual setup.
Use Cases: - Quick onboarding: Get users from signup to working search in seconds - Demo environments: Showcase platform capabilities with real data - Testing: Create consistent test environments with known data - Templates: Provide industry-specific starting points
Requirements: - template_id: REQUIRED, must be unique across all templates - name: REQUIRED, human-readable display name - description: REQUIRED, explains what the template provides - source_namespace_id: REQUIRED, must reference an existing namespace - category: OPTIONAL, defaults to 'general' - is_active: OPTIONAL, defaults to true - created_at: OPTIONAL, auto-generated if not provided
Storage: Stored in MongoDB 'templates' collection with template_id as primary key.
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.
5 - 50"tmpl_ecommerce"
"tmpl_media_library"
"tmpl_document_search"
Human-readable template name. REQUIRED. Displayed in UI for template selection. Should be concise but descriptive. Format: Title case, 3-100 characters.
3 - 100"E-commerce Product Catalog"
"Media Library"
"Document Search"
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.
10 - 500"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"
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_'.
5"ns_golden_ecommerce"
"ns_template_media"
"ns_demo_docs"
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.
"retail"
"media"
"finance"
"healthcare"
"legal"
"education"
"general"
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.
true
false
Timestamp when template was created. OPTIONAL. Auto-generated if not provided. Format: ISO 8601 datetime in UTC.
Response
Successful Response
Namespace template definition.
Templates are pre-configured namespace blueprints that reference a golden source namespace containing pre-processed data. Users can instantiate templates to quickly create fully-functional namespaces without manual setup.
Use Cases: - Quick onboarding: Get users from signup to working search in seconds - Demo environments: Showcase platform capabilities with real data - Testing: Create consistent test environments with known data - Templates: Provide industry-specific starting points
Requirements: - template_id: REQUIRED, must be unique across all templates - name: REQUIRED, human-readable display name - description: REQUIRED, explains what the template provides - source_namespace_id: REQUIRED, must reference an existing namespace - category: OPTIONAL, defaults to 'general' - is_active: OPTIONAL, defaults to true - created_at: OPTIONAL, auto-generated if not provided
Storage: Stored in MongoDB 'templates' collection with template_id as primary key.
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.
5 - 50"tmpl_ecommerce"
"tmpl_media_library"
"tmpl_document_search"
Human-readable template name. REQUIRED. Displayed in UI for template selection. Should be concise but descriptive. Format: Title case, 3-100 characters.
3 - 100"E-commerce Product Catalog"
"Media Library"
"Document Search"
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.
10 - 500"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"
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_'.
5"ns_golden_ecommerce"
"ns_template_media"
"ns_demo_docs"
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.
"retail"
"media"
"finance"
"healthcare"
"legal"
"education"
"general"
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.
true
false
Timestamp when template was created. OPTIONAL. Auto-generated if not provided. Format: ISO 8601 datetime in UTC.