Templates
Taxonomy Templates

Create Taxonomy Template

Changed on

Create template from existing taxonomy.

Supports three template scopes:

  • organization: Available to all users in your organization (default)
  • user: Available only to you
  • system: Available to all organizations (requires Mixpeek admin email)
post/v1/templates/taxonomies/from-taxonomy/{taxonomy_id}

Request

  • Base URL: https://api.mixpeek.com
  • URL: https://api.mixpeek.com/v1/templates/taxonomies/from-taxonomy/{taxonomy_id}
  • Auth: HTTP bearer and API key in header X-Namespace

Path parameters

taxonomy_idstring required

Taxonomy ID

Request body

template_namestring required

Name for the new template

descriptionstring nullable

Description of the template's purpose (OPTIONAL)

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

Optional category for organizing templates

tagsstring[]

Optional tags for the template

is_publicboolean

Whether this template should be publicly discoverable

Example request

{
  "category": "ecommerce",
  "description": "Semantic search optimized for product catalogs",
  "is_public": false,
  "tags": [
    "products",
    "search"
  ],
  "template_name": "My Product Search Pattern"
}

Response

Successful Response

template_idstring required

ID of the created template

template_namestring required

Name of the created template

template_type'namespace' | 'retriever' | 'cluster' | 'collection' | 'bucket' | 'taxonomy' | 'scaffold' required

Types of resources that can be templated.

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

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)

source_resource_idstring required

ID of the resource used to create this template

created_atstring date-time

Timestamp when template was created

Example response

{
  "created_at": "2025-01-15T12:00:00Z",
  "scope": "organization",
  "source_resource_id": "ret_xyz789",
  "template_id": "tmpl_custom_abc123",
  "template_name": "My Product Search Pattern",
  "template_type": "retriever"
}

Changes

  • 61a175e8eb9aRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

  • 38e0822db900Revision changes
    • breaking

      removed the success response with the status

    • info

      added the success response with the status