v1

latestOpenAPI 3.1.02026-08-06244570.4 KB

Templates

Get template layers

List the addressable layers of a template.

Authentication: API Key required (x-api-key header) or JWT token

Usage: The image API (/v1/image/create) targets elements by layer name via its modifications array. This endpoint returns every named layer of the template — the counterpart of /fields for {{ }} variables — so a caller (or an agent) can discover what is modifiable without opening the editor.

The reserved background layer is always present: every image template has a background slot, whether it is an explicit element or the page itself.

No credits consumed: This is a read-only endpoint.

Rate Limits: 60 requests/min (free), 120 requests/min (paid). Headers included in response.

get/v1/templates/{template_id}/layers

Path parameters

template_idstring required

Template short ID (12 characters)

Response

List of template layers

warningsstring[]

Non-fatal issues (e.g. duplicate layer names)

Example response

{
  "layers": [
    {
      "modifiable": [
        "image_url",
        "background",
        "hidden"
      ],
      "name": "background",
      "tag": "div",
      "type": "background"
    },
    {
      "current_text": "Hello from Malta",
      "modifiable": [
        "text",
        "color",
        "hidden"
      ],
      "name": "title",
      "tag": "div",
      "type": "text"
    }
  ],
  "warnings": []
}