Skip to main content

Documentation Index

Fetch the complete documentation index at: https://acme-3f0e8fe2.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

A collection is a batch of renders triggered by one API call. Use it to fan-out a single payload across multiple templates or variations.

​
Use cases

  • One product, many social formats (Instagram square, IG story, Twitter card, OG image)
  • One announcement, many languages
  • One event, many speaker cards

​
Creating a collection

POST /v1/collections
{
  "templates": ["tpl_square", "tpl_story", "tpl_og"],
  "modifications": [
    { "name": "title", "text": "Launch day" },
    { "name": "logo", "image_url": "https://cdn.example.com/logo.svg" }
  ]
}
The response includes a collection_id and the list of child render IDs (one per template). Each child render runs in parallel.

​
Tracking progress

Poll GET /v1/collections/<id> to see aggregate status: 
{
  "id": "col_xyz",
  "status": "rendering",
  "renders_total": 3,
  "renders_completed": 1,
  "renders_failed": 0
}
When renders_completed + renders_failed == renders_total, the collection is finished. See the API reference for collections.