> ## Documentation Index
> Fetch the complete documentation index at: https://docs.mixpeek.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Instantiate Retriever Template

> Instantiate retriever template.



## OpenAPI

````yaml post /v1/templates/retrievers/{template_id}/instantiate
openapi: 3.1.0
info:
  title: Mixpeek API
  description: >-
    This is the Mixpeek API, providing access to various endpoints for data
    processing and retrieval.
  termsOfService: https://mixpeek.com/terms
  contact:
    name: Mixpeek Support
    url: https://mixpeek.com/contact
    email: info@mixpeek.com
  version: '0.82'
servers:
  - url: https://api.mixpeek.com
    description: Production
security: []
paths:
  /v1/templates/retrievers/{template_id}/instantiate:
    post:
      tags:
        - Templates
        - Retriever Templates
      summary: Instantiate Retriever Template
      description: Instantiate retriever template.
      operationId: >-
        instantiate_retriever_template_v1_templates_retrievers__template_id__instantiate_post
      parameters:
        - name: template_id
          in: path
          required: true
          schema:
            type: string
            description: Template ID
            title: Template Id
          description: Template ID
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstantiateRetrieverTemplateRequest'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstantiatedRetrieverTemplateResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    InstantiateRetrieverTemplateRequest:
      properties:
        retriever_name:
          type: string
          maxLength: 100
          minLength: 1
          title: Retriever Name
          description: Name for the new retriever
        collection_identifiers:
          items:
            type: string
          type: array
          minItems: 1
          title: Collection Identifiers
          description: Collection identifiers to use for the retriever
        description:
          anyOf:
            - type: string
              maxLength: 1000
            - type: 'null'
          title: Description
          description: Optional description override for the retriever
        tags:
          items:
            type: string
          type: array
          title: Tags
          description: Optional tags for the retriever
      type: object
      required:
        - retriever_name
        - collection_identifiers
      title: InstantiateRetrieverTemplateRequest
      description: Request to instantiate a retriever from a template.
      examples:
        - collection_identifiers:
            - products
          description: Semantic search for products
          retriever_name: my_product_search
          tags:
            - production
            - products
    InstantiatedRetrieverTemplateResponse:
      properties:
        retriever_id:
          type: string
          title: Retriever Id
          description: ID of the created retriever
        retriever_name:
          type: string
          title: Retriever Name
          description: Name of the created retriever
        template_id:
          type: string
          title: Template Id
          description: ID of the template used
        status:
          type: string
          title: Status
          description: Status of the instantiation
          default: created
        created_at:
          type: string
          format: date-time
          title: Created At
          description: Timestamp when retriever was created
      type: object
      required:
        - retriever_id
        - retriever_name
        - template_id
      title: InstantiatedRetrieverTemplateResponse
      description: Response after instantiating a retriever template.
      examples:
        - created_at: '2025-01-15T12:00:00Z'
          retriever_id: ret_abc123
          retriever_name: my_product_search
          status: created
          template_id: tmpl_semantic_search
    ErrorResponse:
      properties:
        success:
          type: boolean
          title: Success
          description: Always false for error responses
          default: false
        status:
          type: integer
          title: Status
          description: HTTP status code for this error
        error:
          $ref: '#/components/schemas/ErrorDetail'
          description: Error details payload
      type: object
      required:
        - status
        - error
      title: ErrorResponse
      description: Error response model.
      examples:
        - error:
            details:
              id: ns_123
              resource: namespace
            message: Namespace not found
            type: NotFoundError
          status: 404
          success: false
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ErrorDetail:
      properties:
        message:
          type: string
          title: Message
          description: Human-readable error message
        type:
          type: string
          title: Type
          description: Stable error type identifier (machine-readable)
        code:
          anyOf:
            - type: string
            - type: 'null'
          title: Code
          description: >-
            Fine-grained error code for programmatic handling (e.g.,
            namespace_name_taken, feature_extractor_not_found). Present only
            when consumers may need to branch on a specific error condition.
        details:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Details
          description: >-
            Optional structured details to help debugging (validation errors,
            IDs, etc.)
      type: object
      required:
        - message
        - type
      title: ErrorDetail
      description: Error detail model.
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````