> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/figma.md).

# Figma

Read Design files, collaborate with comments, and export node images.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication        |
| --------- | --------------------- |
| Figma     | Personal access token |

#### Figma

Connect to Figma with a scoped personal access token.

**Set up in Figma**

1. Prepare the Figma account or service that the workflow will access. Grant access to the required resources and operations.
2. **Personal access token:** Create a Figma personal access token with current\_user:read, projects:read, file\_content:read, file\_comments:read, and file\_comments:write scopes.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Figma**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field         | Required | What to enter                                                                                                                                                                                                   |
| --------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Personal access token | Yes      | Create a Figma personal access token with current\_user:read, projects:read, file\_content:read, file\_comments:read, and file\_comments:write scopes. [Provider instructions](https://www.figma.com/settings). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Figma** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Get File

Get the structure and metadata of a Figma Design file.

**Required permissions:** `file_content:read`, `projects:read`.

**Inputs**

| Field          | Type            | Required | Description                                                                                                   |
| -------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Team ID        | string          | Yes      | The numeric Figma team ID copied from the team URL.                                                           |
| Project        | select (string) | Yes      | Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection. |
| File           | select (string) | Yes      | Select a Figma file after choosing the project, or type its key. Options load from the selected connection.   |
| Document Depth | integer         | No       | Number of document-tree levels to return. Minimum: 1. Maximum: 10. Default: 2.                                |

**Outputs**

| Field         | Type     | Description                                           |
| ------------- | -------- | ----------------------------------------------------- |
| File Key      | string   | The exact Figma file key.                             |
| File Name     | string   | The Figma Design file name.                           |
| Role          | string   | The connected user's role on the file.                |
| Last Modified | datetime | The file's last-modified time.                        |
| Editor Type   | string   | The confirmed Design editor type.                     |
| Thumbnail URL | string   | A Figma thumbnail URL when available.                 |
| Version       | string   | The returned file version identifier.                 |
| Document      | object   | The typed Figma document tree at the requested depth. |

#### List File Comments

List comments on a Figma file.

**Required permissions:** `file_comments:read`, `projects:read`.

**Inputs**

| Field           | Type            | Required | Description                                                                                                   |
| --------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Team ID         | string          | Yes      | The numeric Figma team ID copied from the team URL.                                                           |
| Project         | select (string) | Yes      | Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection. |
| File            | select (string) | Yes      | Select a Figma file after choosing the project, or type its key. Options load from the selected connection.   |
| Return Markdown | boolean         | No       | Return supported comment formatting as Markdown. Default: false.                                              |

**Outputs**

| Field         | Type          | Description                            |
| ------------- | ------------- | -------------------------------------- |
| File Key      | string        | The file whose comments were returned. |
| Comments      | object\_array | Typed comments on the Figma file.      |
| Comment Count | integer       | Number of comments returned.           |

#### Add Comment to File

Add a comment or reply to a Figma file.

**Required permissions:** `file_comments:write`, `projects:read`.

**Inputs**

| Field               | Type            | Required | Description                                                                                                   |
| ------------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Team ID             | string          | Yes      | The numeric Figma team ID copied from the team URL.                                                           |
| Project             | select (string) | Yes      | Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection. |
| File                | select (string) | Yes      | Select a Figma file after choosing the project, or type its key. Options load from the selected connection.   |
| Comment             | textarea        | Yes      | The exact comment text to add.                                                                                |
| Reply To Comment ID | string          | No       | The root comment ID to reply to.                                                                              |

**Outputs**

| Field      | Type   | Description                      |
| ---------- | ------ | -------------------------------- |
| Comment ID | string | The exact created comment ID.    |
| File Key   | string | The file containing the comment. |
| Comment    | object | The typed created Figma comment. |

#### Export File Images

Render selected nodes from a Figma file as images.

**Required permissions:** `file_content:read`, `projects:read`.

**Inputs**

| Field            | Type            | Required | Description                                                                                                   |
| ---------------- | --------------- | -------- | ------------------------------------------------------------------------------------------------------------- |
| Team ID          | string          | Yes      | The numeric Figma team ID copied from the team URL.                                                           |
| Project          | select (string) | Yes      | Select a Figma project after entering the team ID, or type its ID. Options load from the selected connection. |
| File             | select (string) | Yes      | Select a Figma file after choosing the project, or type its key. Options load from the selected connection.   |
| Node IDs         | textarea        | Yes      | Comma-separated Figma node IDs to render.                                                                     |
| Format           | select (string) | No       | The output image format. Available values: PNG, JPG, SVG, PDF. Default: png.                                  |
| Scale            | number          | No       | Render scale from 0.01 through 4. Minimum: 0.01. Maximum: 4. Default: 1.0.                                    |
| Outline SVG Text | boolean         | No       | Render SVG text as outlines for visual fidelity.                                                              |

**Outputs**

| Field       | Type          | Description                             |
| ----------- | ------------- | --------------------------------------- |
| File Key    | string        | The file containing the exported nodes. |
| Images      | object\_array | One URL result for each requested node. |
| Image Count | integer       | Number of requested node results.       |

#### List Team Projects

List projects visible in a Figma team.

**Required permissions:** `projects:read`.

**Inputs**

| Field   | Type   | Required | Description                                         |
| ------- | ------ | -------- | --------------------------------------------------- |
| Team ID | string | Yes      | The numeric Figma team ID copied from the team URL. |

**Outputs**

| Field         | Type          | Description                             |
| ------------- | ------------- | --------------------------------------- |
| Team ID       | string        | The team whose projects were returned.  |
| Team Name     | string        | The Figma team name.                    |
| Projects      | object\_array | Projects visible to the connected user. |
| Project Count | integer       | Number of visible projects.             |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/figma.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
