---
title: "Instantiate Retriever Template"
method: POST
path: "/v1/templates/retrievers/{template_id}/instantiate"
tags: ["Templates", "Retriever Templates"]
---

# Instantiate Retriever Template

`POST /v1/templates/retrievers/{template_id}/instantiate`

Instantiate retriever template.

## Path parameters

- `template_id` string, required — Template ID

## Request body

- InstantiateRetrieverTemplateRequest — Request to instantiate a retriever from a template.
  - `retriever_name` string, required — Name for the new retriever
  - `collection_identifiers` string[], required — Collection identifiers to use for the retriever
  - `description` string, nullable — Optional description override for the retriever
  - `tags` string[] — Optional tags for the retriever

## Response `201`

Successful Response

- InstantiatedRetrieverTemplateResponse — Response after instantiating a retriever template.
  - `retriever_id` string, required — ID of the created retriever
  - `retriever_name` string, required — Name of the created retriever
  - `template_id` string, required — ID of the template used
  - `status` string — Status of the instantiation
  - `created_at` string, date-time — Timestamp when retriever was created

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `422` — Validation Error
- `500` — Internal Server Error

---

[API](https://skmtc.net/mixpeek/apis/mixpeek-api.md) · [All operations](https://skmtc.net/mixpeek/apis/mixpeek-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/mixpeek/mixpeek-api/revisions/220a3b263fda/schema)