v5

OpenAPI 3.1.02026-08-025631,1012.8 MB

Templates

Retriever Templates

Instantiate Retriever Template

Instantiate retriever template.

post/v1/templates/retrievers/{template_id}/instantiate

Path parameters

template_idstring required

Template ID

Request body

retriever_namestring required

Name for the new retriever

collection_identifiersstring[] required

Collection identifiers to use for the retriever

descriptionstring nullable

Optional description override for the retriever

tagsstring[]

Optional tags for the retriever

Example request

{
  "collection_identifiers": [
    "products"
  ],
  "description": "Semantic search for products",
  "retriever_name": "my_product_search",
  "tags": [
    "production",
    "products"
  ]
}

Response

Successful Response

retriever_idstring required

ID of the created retriever

retriever_namestring required

Name of the created retriever

template_idstring required

ID of the template used

statusstring

Status of the instantiation

created_atstring date-time

Timestamp when retriever was created

Example response

{
  "created_at": "2025-01-15T12:00:00Z",
  "retriever_id": "ret_abc123",
  "retriever_name": "my_product_search",
  "status": "created",
  "template_id": "tmpl_semantic_search"
}