Render Template

Render a template with dynamic variables

This endpoint renders a template with the provided dynamic variables. The response is the rendered image file.

Path Parameters

uid

string

required

The unique identifier of the template to render

Query Parameters

variables

object

An object containing key-value pairs of variable names and their values. The keys should match the variable names defined in the template.

Response

The endpoint returns the rendered image file directly. On success, you’ll receive the image data with the appropriate content type header.

Examples

Here’s how to use the render endpoint with different variable types:

url.sh

# Basic text variable
https://api.sendbetter.co/v1/render/template_abc123?text_headline=Welcome

# Multiple variables
https://api.sendbetter.co/v1/render/template_abc123
    ?text_headline=Welcome
    &image_logo=https://example.com/logo.png

Error Responses

Template Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Template not found",
    "requestId": "req_abc123"
  }
}

Path Parameters

uid

string

required

The unique identifier of the template

Query Parameters

variables

object

Dynamic variables for the template

Show child attributes

variables.{key}

string

Response

200

_mintlify/placeholder

The dynamically rendered image