Templates
Retriever Templates

Get Retriever Template

Changed on

Get retriever template details.

get/v1/templates/retrievers/{template_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/templates/retrievers/{template_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

template_idstring required

Template ID

Response

Successful Response

template_idstring required

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

template_type'namespace' | 'retriever' | 'cluster' | 'collection' | 'bucket' | 'taxonomy' | 'scaffold' required

Types of resources that can be templated.

mode'scaffold' | 'config' | 'clone' | 'manifest'

Mode of template instantiation.

scaffold: Create from pre-built preset - Creates: namespace + bucket + collection + retriever - Endpoint: POST /templates/scaffolds/{id}/instantiate - All resources empty, ready for data

config: Copy resource configuration only - Creates: empty resource with same settings - Endpoint: POST /templates/{resource}/{id}/instantiate - No data copied

clone: Copy resource with all data - Creates: full copy including vectors/embeddings - Endpoint: POST /namespaces/{id}/clone - For a config-only namespace copy, export a manifest and apply it

manifest: A whole pipeline as a Mixpeek manifest - Creates: every resource the manifest declares (connections, buckets, syncs, collections, retrievers, alerts, triggers) - Endpoint: POST /manifest/apply with configuration["manifest"] - For templates that need more than extractors and indexes

scope'system' | 'organization' | 'user' | 'public' required

Scope of template availability.

system: Mixpeek-provided, available to all orgs organization: Private to org members user: Private to creator only public: User-created, discoverable by all orgs (marketplace)

internal_idstring required

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

namestring required

Human-readable template name

descriptionstring required

Detailed description of the template's purpose

categorystring nullable

Optional category for organizing templates

configurationobject required

Template-specific configuration (varies by template_type)

tagsstring[]

Tags for categorizing and filtering templates

is_activeboolean

Whether this template is available for use

is_publicboolean

Whether this template is publicly discoverable without authentication

use_casesstring[]

List of common use cases for this template

requirementsstring[]

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

created_bystring nullable

User ID who created this template (for org templates)

source_resource_idstring nullable

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

sample_namespace_idstring nullable

Reference to a sample/golden namespace for this scaffold (used for Studio quickstart cloning)

example_queriesstring[]

Runnable example queries for this template's sample data; the first renders on the card

whats_insidestring nullable

One-sentence description of the sample corpus (what you get, with counts)

materialize_estimatestring nullable

Honest time estimate for sample data to become searchable after instantiate

created_atstring date-time

Timestamp when template was created

updated_atstring date-time

Timestamp when template was last updated

Example response

{
  "category": "semantic_search",
  "configuration": {
    "input_schema": {},
    "stages": []
  },
  "created_at": "2025-01-15T12:00:00Z",
  "description": "Simple text-based semantic search",
  "internal_id": "system",
  "is_active": true,
  "is_public": true,
  "name": "Basic Semantic Search",
  "scope": "system",
  "template_id": "tmpl_semantic_search",
  "template_type": "retriever"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 06a23e5a9062Revision changes
    • warning

      added the new manifest enum value to the response property for the response status