Templates
Collection Templates

Instantiate Collection Template

Changed on

Instantiate collection template.

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

Request

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

Path parameters

template_idstring required

Template ID

Request body

collection_namestring required

Name for the new collection

bucket_idsstring[] nullable

Bucket IDs to use for the collection (for bucket sources)

collection_idstring nullable

Collection ID to use for the collection (for collection sources)

descriptionstring nullable

Optional description override for the collection

tagsstring[]

Optional tags for the collection

Example request

{
  "bucket_ids": [
    "bkt_products"
  ],
  "collection_name": "my_product_embeddings",
  "description": "Image embeddings for product catalog",
  "tags": [
    "production",
    "products"
  ]
}

Response

Successful Response

collection_idstring required

ID of the created collection

collection_namestring required

Name of the created collection

template_idstring required

ID of the template used

statusstring

Status of the instantiation

created_atstring date-time

Timestamp when collection was created

Example response

{
  "collection_id": "col_abc123",
  "collection_name": "my_product_embeddings",
  "created_at": "2025-01-15T12:00:00Z",
  "status": "created",
  "template_id": "tmpl_image_embeddings"
}

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