Templates
Taxonomy Templates

Instantiate Taxonomy Template

Changed on

Instantiate taxonomy template.

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

Request

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

Path parameters

template_idstring required

Template ID

Request body

taxonomy_namestring required

Name for the new taxonomy

collection_configobject required

Collection configuration for the taxonomy. For flat taxonomies: {'collection_id': 'col_xxx'} For hierarchical taxonomies: maps node collection IDs to actual collection IDs, e.g., {'col_template_root': 'col_actual_root', 'col_template_child': 'col_actual_child'}

descriptionstring nullable

Optional description override for the taxonomy

Example request

{
  "collection_config": {
    "collection_id": "col_products_v1"
  },
  "description": "Product categorization taxonomy",
  "taxonomy_name": "my_product_categories"
}

Response

Successful Response

taxonomy_idstring required

ID of the created taxonomy

taxonomy_namestring required

Name of the created taxonomy

template_idstring required

ID of the template used

statusstring

Status of the instantiation

created_atstring date-time

Timestamp when taxonomy was created

Example response

{
  "created_at": "2025-01-15T12:00:00Z",
  "status": "created",
  "taxonomy_id": "tax_abc123",
  "taxonomy_name": "my_product_categories",
  "template_id": "tmpl_product_taxonomy"
}

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