Productivity
Figma in your product and your AI agents, through one API
The Figma toolkit covers file metadata and content, node rendering, version history, comments, and the components and styles published in libraries. Your customer connects Figma once with OAuth, and your product or AI agent calls each operation through Connect, which stores and renews the credentials and logs every execution.
15 days to try it. No credit card.
POST https://connect.reportei.com/api/tools/figma_create_comment/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>",
"message": "<message>"
}
}How it works
From a connected customer to the first Figma call.
- 1
Your customer connects the account
Your system opens a Connect session for the toolkit and your customer connects their Figma account. You get the connection id.
- 2
Your product calls the tool
A POST to /api/tools/{tool}/execute with the connection id and arguments. On success, Connect preserves the app's response status and body.
- 3
Connect handles the rest
It stores the credential encrypted, renews tokens for OAuth connections that support renewal and records executions in an audit trail available through the API.
Use cases
What your product does with Figma.
Design review inside your app
List a file's comments and post replies or new comments as the connected user, so review feedback lives next to your own workflow.
Export frames as images
Read a frame with Get file nodes and call Render images to get temporary image URLs for handoff, docs or previews.
Agent reads the design system
An AI agent lists a team's published components and styles, then reads their nodes to answer questions about the design system.
Tools
12 Figma tools
- Get file metadataGETReturns the metadata of a file without its content: name, folder, editor type (Figma Design, FigJam, Slides and others), creator, who changed it last and when, thumbnail, the role of the user and the link access. Much cheaper than Get file in the Figma rate limits, so use it first when the question is about the file and not its layers.
- Get fileGETReturns the document tree of a file: pages, frames and layers with their properties and ids, plus the components and styles the file uses. The tree of a large file is huge: pass depth 1 for the pages only, or 2 for the top-level frames of each page, then read a frame with Get file nodes. 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.
- Get file nodesGETReturns the given frames or layers of a file, each with its whole subtree, under nodes, plus the name, version and last change of the file. A node that does not exist comes back as null. It is the light way to read one frame of a large file. 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.
- Render imagesGETRenders 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.
- List file versionsGETLists the version history of a file, newest first: id, creation date, author, and the label and description of named versions. To read older versions, pass as before the before value of the pagination.next_page link; the history ends when next_page is missing.
- List commentsGETLists all the comments of a file, replies included. Each comment has id, message, author, created_at, resolved_at when it was resolved, its position in client_meta and the reactions. A reply carries the id of its root comment in parent_id.
- Create commentPOSTPosts a comment on a file as the connected user and returns it, or a reply when comment_id is sent. Without client_meta the comment is not pinned to a spot of the canvas. A posted comment cannot be edited, only deleted with Delete comment.
- Delete commentDELETEDeletes a comment of a file. Figma only lets the author delete a comment, so it works on the comments made by the connected user.
- List file componentsGETLists the components published from a library file: key, name, description, node_id, thumbnail, dates, author and the frame and page that contain each one. Components that were never published do not appear.
- List team componentsGETLists the components published in the libraries of a team, with the file_key and node_id of each one, which Get file nodes and Render images accept. The response has meta.cursor: pass its after value as after to read the next page; the list ends when after is missing.
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.
Questions about the Figma toolkit
Do I need to build against the Figma API?
No. Connect ships 12 Figma tools, described and ready. Your customer connects the account and your system calls every tool through the same endpoint, with the same request format.
How does my customer connect their Figma account?
With the mode the toolkit accepts: OAuth with your product's app. Connect stores the credential encrypted and never returns it to your system.
Does it work with AI agents?
Yes. Each tool's input is described in JSON Schema, which your agent uses directly as a tool definition. The agent picks the tool and the arguments, and your system makes the call to Connect.
Does my customer need a Reportei account?
No. Your customer connects the account on a Connect screen, or your system sends the credential through the API, and they keep using only your product.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
