Template Static Elements API

This document contains details on static template elements, focusing on image tags, required hash attributes, and the image upload/download API endpoints.

Use this page to add static images to template HTML. Use either an uploaded platform image or a Base64 image.

Supported image sources

Uploaded platform image

Use the image-uuid: source format for images uploaded to the platform.

<img width="100" height="50" src="image-uuid:1abd7329-86f1-4f90-81e7-37ea26fcb3a9" hash="aaf24fa42dg42gd42sgd2s2gsd"/>

Base64 image

Use a Base64 data URI if you want to embed the image directly in the template.

<img width="100" height="50" src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAKAAAABQCAY=="/>

Rules

• Use hash for uploaded platform images.

• Use src="image-uuid:..." for platform images.

• Use src="data:image/...;base64,..." for Base64 images.

• Do not use external image URLs in template HTML.

Use uploaded platform images if you want to reuse the same file across templates. Use Base64 images if you want to keep the image inside one template definition.

How image upload works

1. Upload the image file.

2. Copy src and hash from the upload response.

3. Insert both values into the <img> tag in template HTML.

Upload image

Use this endpoint to upload an image and get the values for the <img> tag.

Field	Value
Method	POST
Request URL	/api/v1/template/image

Upload response example

{
  "imageUuid": "1abd7329-86f1-4f90-81e7-37ea26fcb3a9",
  "src": "image-uuid:1abd7329-86f1-4f90-81e7-37ea26fcb3a9",
  "hash": "aaf24fa42dg42gd42sgd2s2gsd"
}

Use src and hash from this response in the template HTML.

Download image

Use this endpoint to download a previously uploaded image.

Field	Value
Method	GET
Request URL	/api/v1/template/{uuid}/image?imageUuid={required}&envelopeUuid={optional}

Related topics

• Template Structure API

• Create Template

• PDF Fields in Template