Render images with the Figma API

Renders frames or layers of a file as images and returns, in images, a map from each node id to a temporary URL of the image, valid for 30 days. A null value means that node could not be rendered. Images above 32 megapixels are scaled down. Figma puts this call in its smallest rate limit tier: files in a Starter plan, and users with a View or Collab seat, get only up to 20 calls a month.

Identifier
figma_render_images

The request

POST https://connect.reportei.com/api/tools/figma_render_images/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "file_key": "<file_key>",
    "ids": "<ids>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
file_keystringYesKey of the file: the part after /design/, /file/ or /board/ in the URL of the file in Figma. The key of a branch also works.
idsstringYesComma-separated node ids to render, like 1:2,1:3. A node id is the node-id of a Figma link with the hyphen changed to a colon (node-id=1-2 is 1:2), or an id returned by Get file.
formatstringNoImage format. The default is png.Values: jpg, png, svg, pdf
scalenumberNoScale factor, from 0.01 to 4. The default is 1.
versionstringNoId of a version from List file versions, to render the nodes as they were then. Omit it for the current version.
contents_onlybooleanNoWhen true, the default, content of other layers that overlaps the node is left out of the image. False includes it and takes longer.
use_absolute_boundsbooleanNoUses the full size of the node even when it is cropped or has empty space around it, which keeps text layers from being cut. The default is false.

Supported connections

Your customer connects their Figma account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/figma, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/figma_render_images. It becomes your agent's tool definition with no conversion.

Other Figma tools

See all 12 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.