Templates
Cluster Templates

Instantiate Cluster Template

Changed on

Instantiate cluster template.

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

Request

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

Path parameters

template_idstring required

Template ID

Request body

cluster_namestring required

Name for the new cluster

collection_idsstring[] required

Collection IDs to use for the cluster

descriptionstring nullable

Optional description override for the cluster

Example request

{
  "cluster_name": "my_product_clusters",
  "collection_ids": [
    "col_products"
  ],
  "description": "Cluster products by visual similarity"
}

Response

Successful Response

cluster_idstring required

ID of the created cluster

cluster_namestring required

Name of the created cluster

template_idstring required

ID of the template used

statusstring

Status of the instantiation

created_atstring date-time

Timestamp when cluster was created

Example response

{
  "cluster_id": "clust_abc123",
  "cluster_name": "my_product_clusters",
  "created_at": "2025-01-15T12:00:00Z",
  "status": "created",
  "template_id": "tmpl_visual_clustering"
}

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