API Keys & Integration

URL Builder Tool

The **GET URL Builder** is an interactive tool that helps you construct and test Dynamic Image URLs without manually building query strings. It generates ready-to-use URLs that you can embed directly

How to Use#

1. Select a Template#

Choose the template you want to render from the dropdown. The builder will automatically detect any dynamic layers configured in the template.

2. Paste Your GET API Key#

Enter your full GET API key (starts with rs_get_). The builder shows your existing GET key names for reference, but you need to paste the full key value. If you don't have a GET key yet, create one from the API Keys page.

3. Configure Output (Optional)#

  • Width / Height: Override the template's default dimensions. Leave blank to use the template's original size.
  • Format: Choose PNG or JPEG. Defaults to the template's configured format.
  • Quality: Set JPEG quality (1–100). Only applies when format is JPEG.

4. Override Dynamic Layers#

If your template has dynamic layers, the builder displays an input field for each one. Fill in only the layers you want to change — the rest will use their template defaults.

Auto-Hide Layers: If a layer has its visibility mode set to Auto in the template editor, leaving its field blank will completely hide that element from the rendered image — no placeholder, no border, nothing. This is ideal for optional elements like a second speaker photo or an optional badge. See Layers — Visibility Modes for details.

Layer overrides use dot-notation in the URL. For example:

  • header_text_1.text=Hello sets the text of the header_text_1 layer
  • logo.src=https://example.com/logo.png sets the image source of the logo layer
  • card_1.fill=#ff0000 sets the fill color of the card_1 shape

Repeater Layers#

If your template contains a Repeater element, it appears in the overrides list as a multi-line textarea (not a single-line input). Type or paste a JSON array directly into the field — one object per row, where each key is a child layer's API name:

[
  { "item_name": "Widget A", "item_price": "$10.00" },
  { "item_name": "Widget B", "item_price": "$20.00" }
]

The builder automatically Base64-encodes the array and includes it in the generated URL. If the JSON you enter is invalid, that repeater parameter is omitted from the URL. See Repeater Elements for the full data format reference.

5. Test and Copy#

  • Test Render: Click to preview the rendered image directly in the builder.
  • Copy URL: Copy the full URL to your clipboard for use in your website or application.
  • Open in New Tab: Opens the URL in a new browser tab to see the raw rendered image.

Requirements#

For the GET URL Builder to work, you need:

  1. At least one GET API key (create from API Keys)
  2. At least one Allowed Host configured in Settings (e.g., your domain or localhost for testing)
  3. A saved template with the layers you want to override

Troubleshooting#

IssueSolution
Image fails to renderVerify your GET key is valid and not revoked
403 Forbidden errorEnsure at least one Allowed Host is configured in Settings
No dynamic layers shownMark layers as "Dynamic" in the template editor
JPEG quality has no effectQuality only applies when format is set to JPEG