Sign in
Templates
Cluster Templates

List Cluster Templates

List cluster templates (system + organization + user).

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

post/v1/templates/clusters

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
}

Changes

Changed in 2 of the 30 revisions of this API.4

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 7cb0515333113See the full diff
    • ○

      added the optional property results/items/example_queries to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property results/items/materialize_estimate to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property results/items/whats_inside to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog