Skip to Content

Templates

A template defines the visual layout and size used when generating a carousel. Use this endpoint to discover the templates available in your workspace, then reference a template id when generating designs.

Requires the embed-api-key header — see Authentication.


List templates

GET /template

Returns templates in your workspace, most recently updated first.

Query parameters

ParameterDefaultDescription
page1Page number (positive integer).
limit10Items per page (1100).

Response 200

{ "success": true, "data": { "templates": [ { "id": "template_123", "name": "Bold Headlines", "size": "1080x1350" } ] } }
FieldDescription
idTemplate id — pass this when generating a carousel.
nameHuman-readable template name.
sizeThe template’s canvas size.

Errors

StatusBodyWhen
404{ "success": false, "message": "No templates found" }The workspace has no templates.
422{ "status": false, "message": "Page must be a positive integer" }Invalid page.
422{ "status": false, "message": "Limit must be between 1 and 100" }Invalid limit.
500{ "success": false, "message": "Error fetching Templates", ... }Unexpected server error.

See Authentication for 401 / 402 responses.

Last updated on