Create a carousel

Render selected pages of one saved template version as images, in the requested order. Creates one normal image job per page. The ledger reserves one credit per job, settles it on success, and releases it on failure. A successful PDF of the same pages still costs one credit through POST /v1/pdf.

post/v1/carousels

Request

  • Base URL: https://thirds.ai
  • URL: https://thirds.ai/v1/carousels
  • Auth: HTTP bearer

Headers

Idempotency-Keystring required

Request body

template_idstring required
versioninteger

Omitted to use the template's latest version at creation time.

dataobject

Template data applied to every selected page. Omitted to use an empty object.

format'png' | 'jpeg' | 'webp' required
pagesstring[] required

1 to 100 different canvas data-thirds-page ids in output order.

Response

The carousel was created, or an earlier request with the same idempotency key and body is replayed.

idstring required
template_idstring required
versioninteger required
format'png' | 'jpeg' | 'webp' required
created_atstring date-time required
state'queued' | 'running' | 'complete' | 'partial' | 'failed' required
archive_urlstring nullable required

A signed ZIP download link, present once any member has succeeded.

Changes

No recorded changes to this operation across all 1 revision of this API.