Create Template

Create a new image template that can be used for generating images.

Request

POST https://api.ojo.so/v1/template

Headers

Request Body

The HTML content must be Base64 encoded. You can encode your HTML content using our HTML Encoder (opens in a new tab), or use standard Base64 encoding functions available in your programming language:

// JavaScript example
const encodedHtml = btoa('<div>Hello World!</div>');

# Python example
import base64
encoded_html = base64.b64encode('<div>Hello World!</div>'.encode()).decode()

Dynamic Template

You can create your template with Handlebars expressions and generate images by providing the necessary data. When making a request to generate an image, include a modify object in your request body with the data to populate your Handlebars placeholders. Learn how to create image with variables.

Example:

{
  "templateId": "template-uuid-123",
  "modify": {
    "title": "Welcome to Our Site",
    "user": {
      "name": "Alice Smith"
    },
    "showDetails": true,
    "items": ["Item 1", "Item 2", "Item 3"]
  }
}

curl --request POST \
  --url https://api.ojo.so/v1/template \
  --header 'Authorization: Bearer <API Key>' \
  --header 'Content-Type: application/json' \
  --header 'x-template-defaults: {"title":"Default Title"}' \
  --data '{
    "html": "...encoded HTML content...",
    "variables": {
      "title": "My Template Title"
    }
  }'

Response

{
  "id": "template-uuid-123",
  "message": "Template created successfully"
}