Render image from HTML

Last modified: August 09, 2022Author: Jakub Pomykała

This endpoint allows you to create images based on a template designed in HTML Template Editor.

POST Endpoint

https://get.renderform.io/api/v1/render

Example request

curl 
    --location 
    --request POST 'https://get.renderform.io/api/v1/render' \
    --header 'X-API-KEY: <API_KEY>' \
    --header 'Content-Type: application/json' \
    --data-raw '{
        "template": "<TEMPLATE_ID>",
        "mergeFields": {
            "myMergeTag": "My HTML Editor Value"
            "myArray": [
                "First",
                "Second"
            ]
        }
    }'

Request body

  • template (required) - template identifier,
  • mergeFields (optional) - values for merge fields for given template,
  • expires (optional) - link expiration time in seconds, available values from 1 to 604800,
  • webhookUrl (optional) - send response to the given URL as a POST request
  • metadata (optional) - any JSON object, can be used as metadata container

Successful response

{
  "requestId": "febbd34c-cadf-43e6-926c-5942016aea4e",
  "href": "https://cdn.renderform.io/.../febbd34c-cadf-43e6-926c-5942016aea4e.jpg"
}

GET Endpoint

https://get.renderform.io/img/TEMPLATE_ID.jpg?property=value&apiKey=API_KEY

Use Query String notation in order to provide changes.

Sample request

https://get.renderform.io/img/MY_TEMPLATE_ID.jpg?myTextProperty=Hello!&myImageUrl=example.com/me.jpg&apiKey=MY_API_KEY

Please note that only the first change element is separated with ? (question mark) and all other changes must be separated with & (ampersand).