Variants

Get Variant

Get a variant by ID. Refreshes signed URL if expired.

get/v1/template/{template_id}/variant/{variant_id}

Request

  • Base URL: https://layerre.com (the document declares no server; this is the origin it was published from)
  • URL: https://layerre.com/v1/template/{template_id}/variant/{variant_id}
  • Auth: HTTP bearer

Path parameters

template_idstring uuid required
variant_idstring uuid required

Response

Variant retrieved successfully

idstring uuid required
template_idstring uuid required
urlstring required

Rendered variant URL

signed_url_expirystring date-time nullable
widthinteger required

Variant width in pixels

heightinteger required

Variant height in pixels

page_numberinteger

Page index this variant was rendered from (0-based)

is_combined_pdfboolean

True when this variant is a multi-section combined PDF

combined_section_countinteger nullable

Number of variant sections merged into a combined PDF

created_atstring date-time required
updated_atstring date-time required
warningsstring[] nullable

Example response

{
  "url": "https://example.com/variant.png",
  "width": 800,
  "height": 600,
  "overrides": [
    {
      "properties": {
        "width": 100,
        "height": 100,
        "color": "#FF0000",
        "text": "Hello World",
        "font_size": 16,
        "font_name": "Arial",
        "text_direction": "rtl",
        "line_spacing": 1000,
        "vertical_align": "middle",
        "img_url": "https://example.com/image.png",
        "opacity": 1
      }
    }
  ]
}

Changes

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