Skip to main content
POST
/
v1
/
templates
/
retrievers
/
{template_id}
/
instantiate
Instantiate Retriever Template
curl --request POST \
  --url https://api.mixpeek.com/v1/templates/retrievers/{template_id}/instantiate \
  --header 'Content-Type: application/json' \
  --data '
{
  "retriever_name": "<string>",
  "collection_identifiers": [
    "<string>"
  ],
  "description": "<string>",
  "tags": [
    "<string>"
  ]
}
'
{
  "retriever_id": "<string>",
  "retriever_name": "<string>",
  "template_id": "<string>",
  "status": "created",
  "created_at": "2023-11-07T05:31:56Z"
}

Headers

​
Authorization
string

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

​
X-Namespace
string

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

Path Parameters

​
template_id
string
required

Template ID

Body

application/json

Request to instantiate a retriever from a template.

​
retriever_name
string
required

Name for the new retriever

Required string length: 1 - 100
​
collection_identifiers
string[]
required

Collection identifiers to use for the retriever

Minimum array length: 1
​
description
string | null

Optional description override for the retriever

Maximum string length: 1000
​
tags
string[]

Optional tags for the retriever

Response

Successful Response

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
default:created

Status of the instantiation

​
created_at
string<date-time>

Timestamp when retriever was created