v5

OpenAPI 3.1.02026-08-025631,1012.8 MB

Templates

Taxonomy Templates

Instantiate Taxonomy Template

Instantiate taxonomy template.

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

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"
}