Book a demo

Create Image From Template

apitemplate.create_image
ActionBusiness appsconnection required

Calls the APITemplate.io API with the connection's credentials.

Render a saved image template, overriding its layers with your values.

Ask about APITemplate.ioAll APITemplate.io nodesProvider API docs ↗

Connection

Required
Yes — the node will not save without one
Auth type
API key
Providers
APITemplate.io
Secret shape
the API key, or {"api_key": "…"}
Config it needs
base_url
Resolved by
config.connection_id, else node.connection_id

Configuration

5 fields, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.

FieldTypeRequiredDefaultConstraintsExample
template_id
The image template to render, as shown in the APITemplate.io web console.
stringYes——00377b2b1e0ee394
overrides
One object per layer to change, each with the layer's 'name' and the properties to set, such as 'text' or 'src'.
arrayNo—array of object[{"name":"text_1","text":"hello world"}]
output_image_type
Which images to produce. 'all' returns both a JPEG and a PNG.
stringNoallone of "all", "jpegOnly", "pngOnly"—
expiration
Minutes before APITemplate deletes the file from its CDN. 0 keeps it permanently.
numberNo—0–10080—
meta
Your own reference for this render; it comes back on apitemplate.list_objects.
stringNo——inv-iwj343jospig

Example configuration

Every value below is the contract’s own example or default — nothing invented.

{
  "meta": "inv-iwj343jospig",
  "output_image_type": "all",
  "overrides": [
    {
      "name": "text_1",
      "text": "hello world"
    }
  ],
  "template_id": "00377b2b1e0ee394"
}

Output

One shape.

result

FieldTypeExample
status
APITemplate's own verdict for the render: 'success'.
string—
download_url
URL of the generated JPEG on APITemplate's CDN.
string—
download_url_png
URL of the generated PNG; empty when output_image_type is 'jpegOnly'.
string—
template_id
The template that was rendered.
string—
transaction_ref
APITemplate's reference for this render; pass it to apitemplate.delete_object.
string—
post_actions
Results of any configured Post Actions, such as an upload to your own S3 bucket.
array—
{
  "download_url": "",
  "download_url_png": "",
  "post_actions": [],
  "status": "",
  "template_id": "",
  "transaction_ref": ""
}

Notes

  • Images are always returned as CDN URLs — APITemplate has no 'file' export type for the image endpoint.
  • Every render spends one of the account's API credits; apitemplate.account_information reports how many are left.

Related APITemplate.io nodes

See Create Image From Template run in a workflow.

In a technical demo we add the APITemplate.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.

Book a technical demoTalk to sales