Render Images
figma.render_images
ActionBusiness appsconnection required
Calls the Figma API with the connection's credentials.
Render nodes of a file to PNG, JPG, SVG or PDF and return their download URLs, reporting any node that failed to render.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Figma
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}, or {"personal_access_token": "figd_…"}
- Config it needs
- base_url, plan_api_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
6 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
file_key The Figma file key — the segment after /design/ or /file/ in the file URL. | string | Yes | — | — | — |
ids Comma-separated node ids to render, e.g. 1:2,1:3. | string | Yes | — | — | — |
format Output image format. Figma defaults to png. | string | No | png | one of "jpg", "png", "svg", "pdf" | — |
scale Image scaling factor between 0.01 and 4. | number | No | — | 0.01–4 | — |
version A version id from the file's history; omit to render the current one. | string | No | — | — | — |
use_absolute_bounds Render the node's full dimensions even when it is cropped — use this to export text nodes without clipping. | boolean | No | false | — | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"format": "png",
"use_absolute_bounds": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
images A map from node id to its image URL, or null. | object | — |
rendered_node_ids The node ids Figma rendered. The URLs expire after 30 days. | array | — |
failed_node_ids The node ids Figma returned null for — no renderable content, or no such node. | array | — |
err Figma's error value; null on a successful request. | any | — |
{
"err": null,
"failed_node_ids": [],
"images": {},
"rendered_node_ids": []
}See Render Images run in a workflow.
In a technical demo we add the Figma connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.