Sign in

v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB
Templates
Retriever Templates

List Retriever Templates

List retriever templates (system + organization + user).

Supports filtering, sorting, and search like other list operations.

Request Body (optional):

  • filters: Attribute-based filters {"AND": [{"field": "category", "operator": "eq", "value": "semantic_search"}]}
  • sort: Sort options {"field": "name", "direction": "asc"}
  • search: Wildcard search across template_id, name, description, tags
  • scope: Filter by scope (system, organization, user)
  • category: Filter by category
  • is_active: Show only active templates (default: true)
  • tags: Filter by tags (templates must have ALL specified tags)
post/v1/templates/retrievers

Request body

filtersobject nullable

Filters to apply when listing templates. Format: {"AND": [{"field": "field_name", "operator": "eq", "value": "value"}]}

sortobject nullable

Sort options for the results. Format: {'field': 'name', 'direction': 'asc'}

searchstring nullable

Search term for wildcard search across template_id, name, description, and tags

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

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)

categorystring nullable

Filter by category

is_activeboolean

Show only active templates

tagsstring[] nullable

Filter by tags (templates must have ALL specified tags)

Example request

{
  "category": "semantic_search",
  "is_active": true,
  "scope": "system",
  "search": "semantic"
}

Response

Successful Response

total_countinteger required

Total number of templates matching the query

Example response

{
  "results": [
    {
      "category": "semantic_search",
      "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"
    }
  ],
  "total_count": 1
}