# Figma
Your Toolhouse AI Worker can connect to Figma using 53 specialized tools.
## Auth Connection
This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=figma).
## Tools (53)
### `Figma Add A Comment To A File`
Integration name: **FIGMA\_ADD\_A\_COMMENT\_TO\_A\_FILE**
Posts a new comment to a Figma file or branch, optionally replying to an existing root comment (replies cannot be nested); `region_height` and `region_width` in `client_meta` must be positive if defining a comment region.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------- | ------ | :------: | ------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `message` | string | ✅ | `"Great work on this design!"` | Text content of the comment. |
| `file_key` | string | ✅ | `"sFHgQh9dL6369o5wrZHmdR"` | Figma file key or branch key. Extract from the file URL: ... or ... The FILE\_KEY is the alphanumeric string between 'design/' or 'file/' and the next slash. You must have access to the file (editor or commenter permissions required to add comments). For branch keys, use GET /v1/files/:key with branch\_data parameter. |
| `comment_id` | string | | `"12345"` | ID of an existing root comment to reply to. Replies cannot be made to other replies. |
| `client_meta` | object | | `"{\"x\": 100, \"y\": 200}"` | Dictionary specifying the comment's position. Valid formats: 1) Absolute coordinates: {x, y} 2) Node-relative: {node\_id, node\_offset: {x, y}} (when node\_id is used, coordinates MUST be inside node\_offset) 3) Absolute region: {x, y, region\_height, region\_width, comment\_pin\_corner?} 4) Node-relative region: {node\_id, node\_offset: {x, y}, region\_height, region\_width, comment\_pin\_corner?}. While technically optional, providing this parameter is strongly recommended to properly position the comment in the file. |
***
### `Figma Add A Reaction To A Comment`
Integration name: **FIGMA\_ADD\_A\_REACTION\_TO\_A\_COMMENT**
Posts a specified emoji reaction to an existing comment in a Figma file or branch, requiring valid file\_key and comment\_id.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | ---------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `emoji` | string | ✅ | `":heart:"` | The emoji to use for the reaction, specified as a shortcode (e.g., `:heart:`, `:+1::skin-tone-2:`). For a comprehensive list of accepted emoji shortcodes, including aliases and skin tone modifiers, refer to the file linked here: . |
| `file_key` | string | ✅ | `"figma_file_key_123"` | Identifier of the Figma file or branch to which the comment reaction will be posted. This can be a file key (e.g., from the file URL) or a branch key. Use the `GET /v1/files/:key` endpoint with the `branch_data=true` query parameter to obtain the branch key if needed. |
| `comment_id` | string | ✅ | `"1234567890"` | The unique identifier of the comment to which the reaction should be added. |
***
### `Figma Create A Webhook`
Integration name: **FIGMA\_CREATE\_A\_WEBHOOK**
Creates a Figma webhook to receive POST notifications when specific events occur. Webhooks can monitor events at three scopes: - Team level: monitors all files in a team (requires team admin permissions) - Project level: monitors all files in a project (requires edit access) - File level: monitors a specific file (requires edit access) Upon creation, Figma sends an initial PING event to verify your endpoint (unless status is PAUSED). IMPORTANT: team\_id, project\_id, and file\_key cannot be discovered programmatically. Extract them from Figma URLs or use FIGMA\_DISCOVER\_FIGMA\_RESOURCES to parse URLs.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------- | ------ | :------: | ---------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `status` | string | | `"ACTIVE"` | Initial webhook status. `ACTIVE` (default): webhook is operational and receives an initial PING event upon creation. `PAUSED`: webhook is inactive and receives no events; use FIGMA\_UPDATE\_A\_WEBHOOK to activate later. |
| `context` | string | | `"team"` | Scope of the webhook. Use with `context_id`. `team`: monitors all files in a team (requires team admin). `project`: monitors all files in a project (requires edit access). `file`: monitors a specific file (requires edit access). If not provided, `team_id` must be specified instead. |
| `team_id` | string | | `"1234567890123456789"` | DEPRECATED: Use `context='team'` with `context_id` instead. Identifier of the Figma team for which this webhook monitors events. To find your team\_id: navigate to your team page in Figma (), the team\_id is the number after '/team/' in the URL. Note: team\_ids cannot be discovered programmatically via the API. |
| `endpoint` | string | ✅ | `"https://example.com/api/figma-webhooks"` | Publicly accessible HTTPS URL (max 2048 chars) that receives POST requests from Figma when the event triggers. Must be reachable from the internet. Figma sends JSON payloads with event details to this endpoint. |
| `passcode` | string | ✅ | `"mySecretPasscode123"` | Secret string (max 100 chars) included in the webhook payload for verification. Use this to verify that incoming requests to your endpoint are genuinely from Figma. |
| `context_id` | string | | `"1234567890123456789"` | ID of the context (team, project, or file) to monitor. For team: extract from URL ... For project: extract from URL or use FIGMA\_GET\_PROJECTS\_IN\_A\_TEAM. For file: use the file\_key from URL ... Required when `context` is specified. |
| `event_type` | string | ✅ | `"FILE_COMMENT"` | Type of event that triggers the webhook. FILE\_UPDATE: triggered when a file is saved/modified. FILE\_DELETE: triggered when a file is deleted. FILE\_VERSION\_UPDATE: triggered when a new version is added to file history. FILE\_COMMENT: triggered when a comment is added. LIBRARY\_PUBLISH: triggered when a library is published. |
| `description` | string | | `"Webhook for new file comments in Project X"` | Optional human-readable description for the webhook (max 150 chars). Useful for identifying the webhook's purpose in the team's webhook list. |
***
### `Figma Create Dev Resources`
Integration name: **FIGMA\_CREATE\_DEV\_RESOURCES**
Creates and attaches multiple uniquely-URLed development resources to specified Figma nodes, up to 10 per node.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------------- | ----- | :------: | ------- | ---------------------------------------- |
| `dev_resources` | array | ✅ | — | List of development resources to create. |
***
### `Figma Create Modify Delete Variables`
Integration name: **FIGMA\_CREATE\_MODIFY\_DELETE\_VARIABLES**
Manages variables, collections, modes, and their values in a Figma file via batch create/update/delete operations; use temporary IDs to link new related items in one request and ensure `variableModeValues` match the target variable's `resolvedType`.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------------------- | ------ | :------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"your_figma_file_key"` | The key of the Figma file or branch to modify variables in. Use `GET /v1/files/:key` with the `branch_data=true` query parameter to obtain a branch key. |
| `variables` | array | | — | List of operations for variables. Each item specifies an action (CREATE, UPDATE, DELETE) and the relevant fields. Maximum 5000 variables per collection. Variables cannot be created in extended collections. |
| `variableModes` | array | | — | List of operations for modes. Each item specifies an action (CREATE, UPDATE, DELETE) and the relevant fields. Maximum 40 modes per collection. Modes cannot be created/updated in extended collections (only deleted if parent mode was deleted). |
| `variableModeValues` | array | | — | List of value assignments for variables in specific modes. Each item sets the value of a variable in a particular mode. Values must match the variable's resolvedType. |
| `variableCollections` | array | | — | List of operations for variable collections. Each item specifies an action (CREATE, UPDATE, DELETE) and the relevant fields for that action. |
***
### `Figma Delete A Comment`
Integration name: **FIGMA\_DELETE\_A\_COMMENT**
Deletes a specific comment from a Figma file or branch, provided the authenticated user is the original author of the comment.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `file_key` | string | ✅ | `"sFHgQh9dL6369o5wrZHmdR"` | The key of the Figma file or branch from which the comment will be deleted. This can be a file key (typically found in the file's URL, e.g., 'sFHgQh9dL6369o5wrZHmdR' from ...) or a branch key. To obtain a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter. |
| `comment_id` | string | ✅ | `"1602410633"` | The unique string identifier of the comment to be deleted. This ID can be obtained from the response of `GET /v1/files/:file_key/comments` or from the response when creating a comment with `POST /v1/files/:file_key/comments`. Only the author of the comment can delete it. |
***
### `Figma Delete A Reaction`
Integration name: **FIGMA\_DELETE\_A\_REACTION**
Deletes a specific emoji reaction from a comment in a Figma file; the user must have originally created the reaction.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `emoji` | string | ✅ | `"❤️"` | The specific emoji character (e.g., '❤️', '👍') of the reaction to delete. This must be an exact match to the emoji of an existing reaction on the comment. |
| `file_key` | string | ✅ | `"LFq2TMI2qg1hcvud2jNtC2"` | Key of the file or branch containing the comment reaction to be deleted. The file key can be obtained from the file URL or API responses. To get a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter. |
| `comment_id` | string | ✅ | `"12345:67890"` | Identifier of the comment from which the reaction will be removed. This ID is specific to the comment within the Figma file. |
***
### `Figma Delete A Webhook`
Integration name: **FIGMA\_DELETE\_A\_WEBHOOK**
Permanently deletes an existing webhook, identified by its unique `webhook_id`; this operation is irreversible.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | ---------- | --------------------------------------------------- |
| `webhook_id` | string | ✅ | `"789123"` | The unique identifier of the webhook to be deleted. |
***
### `Figma Delete Dev Resource`
Integration name: **FIGMA\_DELETE\_DEV\_RESOURCE**
Deletes a development resource (used to link Figma design elements to external developer information like code or tasks) from a specified Figma file.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------------- | ------ | :------: | -------------------------- | -------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"sFpP99JA1Z42wZcR5yB12d"` | Identifier of the Figma file from which to delete the dev resource. Must be a main file key, not a branch key. |
| `dev_resource_id` | string | ✅ | `"dev_res_123abc"` | Identifier of the dev resource to delete from the file. |
***
### `Figma Design Tokens To Tailwind`
Integration name: **FIGMA\_DESIGN\_TOKENS\_TO\_TAILWIND**
Convert design tokens to Tailwind CSS configuration. TWO-STEP WORKFLOW: 1. First, call FIGMA\_EXTRACT\_DESIGN\_TOKENS with a Figma file\_key to extract design tokens 2. Then, pass the returned DesignTokens object to this action's 'tokens' parameter This action generates: - tailwind.config.ts/js with theme extensions - Optional globals.css with font imports Note: Shadow colors can be provided in either string format (e.g., "rgba(15, 110, 110, 0.32)") or dictionary format (e.g., {"r": 0.059, "g": 0.431, "b": 0.431, "a": 0.32}).
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------------------- | ------- | :------: | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `prefix` | string | | — | Prefix for generated token names (e.g., 'brand-') |
| `tokens` | object | ✅ | `{"colors":[{"name":"primary","value":"#3B82F6","source":"style","opacity":null,"usage_count":5}],"shadows":[{"name":"card-shadow","source":"style","shadows":[{"x":0,"y":4,"blur":6,"type":"DROP_SHADOW","color":{"a":0.1,"b":0,"g":0,"r":0}}],"usage_count":2}],"sources":{"style":3,"extracted":2},"spacing":[{"name":"padding-16","type":"padding","value":16,"source":"extracted","usage_count":10}],"typography":[{"name":"heading","source":"style","font_size":24,"font_family":"Inter","font_weight":700,"line_height":32,"usage_count":3,"letter_spacing":null,"text_transform":null}],"total_tokens":5,"border_radius":[{"name":"radius-8","value":8,"source":"extracted","usage_count":7}]}` | Design tokens object obtained from the FIGMA\_EXTRACT\_DESIGN\_TOKENS action output. Contains colors, typography, spacing, border\_radius, shadows, total\_tokens, and sources. |
| `config_format` | string | | — | Output format: 'ts' for TypeScript or 'js' for JavaScript |
| `include_font_imports` | boolean | | — | Include @import statements for Google Fonts |
***
### `Figma Detect Background`
Integration name: **FIGMA\_DETECT\_BACKGROUND**
Detect background layers for selected nodes in a Figma file. This action analyzes the Figma document structure and identifies potential background elements for the given target nodes. It uses: - Geometric analysis (bounding box overlap/containment) - Z-index ordering (nodes earlier in the layer stack are behind later ones) - Visual properties (fills, node types) - Naming conventions (nodes named 'background', 'bg', etc.) Returns background candidates with confidence scores (0-1) and explanations.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | — | File key extracted from a Figma Design file URL. Example: 'abc123XYZ' from URL figma.com/design/abc123XYZ/My-Design. NOT supported: FigJam boards or Slides. |
| `search_depth` | integer | | — | How many levels up in the node hierarchy to search for backgrounds. Higher values find more distant ancestors but take longer. Default: 3. |
| `target_node_ids` | array | ✅ | — | List of node IDs to find background layers for. Node IDs can be found in Figma URLs after 'node-id=' parameter, e.g., '1:2' or '123:456'. The action will search for potential background elements that are behind these target nodes. |
***
### `Figma Discover Figma Resources`
Integration name: **FIGMA\_DISCOVER\_FIGMA\_RESOURCES**
Smart Figma resource discovery - extract IDs from any Figma URL. Supports all URL formats: /file/, /design/, /board/, /proto/, /slides/ Example: figma.com/board/ABC123/Name → file\_key=ABC123 Discovery workflow: team\_id → projects → files → nodes Use extracted IDs with GetFileJson, DetectBackground, etc.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `team_id` | string | | — | Team ID to list all projects from. Get this from team URL: . Returns list of projects with IDs and names. Cannot be inferred from user identity or FIGMA\_GET\_CURRENT\_USER; must come from a team URL or be provided directly. |
| `file_key` | string | | — | File key to extract all node IDs from. Get this from file URL (figma.com/file/FILE\_KEY/...) or from project files list. Returns hierarchical list of all nodes with IDs, names, types, and paths. |
| `figma_url` | string | | — | Full Figma URL to extract file\_key, node\_id, and team\_id from. Works with any Figma URL format: • File: • Design: • Board: • Prototype: • Slides: • With node: • Team: This is the easiest way to get all IDs you need! Node IDs in URLs use hyphens (123-456) but Figma JSON uses colons (123:456) — convert format when passing to other tools. If extracted\_ids.file\_key returns null, parse it manually from the path segment after /file/, /design/, /board/, /proto/, or /slides/. |
| `max_depth` | integer | | — | Maximum tree depth to traverse when discovering nodes. 2=pages+frames, 3=pages+frames+components, etc. Higher values find more nodes but take longer. Responses at depth 4+ or broad file\_key traversal can exceed 20k tokens with significant latency; cap at 2–3 and target specific CANVAS or FRAME node IDs to limit response size. |
| `project_id` | string | | — | Project ID to list all files from. Get this from project URL or from team projects list. Returns files with keys, names, and thumbnails. |
***
### `Figma Download Figma Images`
Integration name: **FIGMA\_DOWNLOAD\_FIGMA\_IMAGES**
Download images from Figma file nodes. Renders specified nodes as images and downloads them. Supports PNG, SVG, JPG, and PDF formats. REQUIRED PARAMETERS: - file\_key (string): The Figma file key from the URL - images (array): List of objects, each containing: - node\_id (string, required): The node ID to export (e.g., "1:2") - file\_name (string, required): Output filename with extension (e.g., "logo.png") - format (string, optional): One of 'png', 'svg', 'jpg', 'pdf'. Defaults to 'png' Example usage: { "file\_key": "abc123XYZ", "images": \[ {"node\_id": "1:2", "file\_name": "logo.png", "format": "png"} ] } To find node IDs, use FIGMA\_GET\_FILE\_JSON or look in Figma URLs after 'node-id='. NOTE: Returned image URLs expire shortly after generation — download them immediately.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `scale` | number | | — | Image scaling factor for PNG/JPG exports (0.01 to 4). Default is 2 for retina quality. Ignored for SVG/PDF. Exports are capped at \~32 megapixels; reduce scale or split large nodes to avoid hitting this limit. |
| `images` | array | ✅ | — | REQUIRED. A list of image download requests. Each item must be an object with 'node\_id' (string, required), 'file\_name' (string, required), and optionally 'format' (string, defaults to 'png'). Example: \[{"node\_id": "1:2", "file\_name": "logo.png"}] |
| `file_key` | string | ✅ | — | REQUIRED. The Figma file key extracted from a Figma URL. For URL '', the file\_key is 'abc123XYZ'. This identifies which Figma file to download images from. |
| `svg_include_id` | boolean | | — | For SVG exports only: include element IDs in the SVG output. Defaults to false. |
| `svg_outline_text` | boolean | | — | For SVG exports only: convert text to paths for accurate rendering. Defaults to true. |
| `svg_simplify_stroke` | boolean | | — | For SVG exports only: simplify strokes for cleaner SVG output. Defaults to true. |
***
### `Figma Extract Design Tokens`
Integration name: **FIGMA\_EXTRACT\_DESIGN\_TOKENS**
Extract design tokens from Figma files by combining styles, variables, and node-extracted values. Only values defined as Figma styles or variables are captured — any design values not encoded as styles/variables are silently omitted. Requires `file_variables:read` scope and a Figma plan that supports variables for full output; if variables return empty, supplement with FIGMA\_GET\_LOCAL\_VARIABLES.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------------------- | ------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | — | The Figma file key (e.g., 'aA1b2Cd3E4F5g6H7i8J9k0L'). Extract from Figma URLs like figma.com/file/FILE\_KEY/... or use FIGMA\_DISCOVER\_FIGMA\_RESOURCES to find file keys |
| `include_variables` | boolean | | — | Include variables in extraction. Even with this enabled, modes and scopes may be incomplete; use FIGMA\_GET\_LOCAL\_VARIABLES for full semantic token coverage including variable modes and aliases. |
| `extract_from_nodes` | boolean | | — | Extract tokens from node properties |
| `include_local_styles` | boolean | | — | Include local styles in extraction |
***
### `Figma Extract Prototype Interactions`
Integration name: **FIGMA\_EXTRACT\_PROTOTYPE\_INTERACTIONS**
Extract prototype interactions and animations from Figma files. Required parameter: - file\_key: The Figma file key extracted from a URL like '' (the 'ABC123xyz' part) Analyzes the prototype data to extract: - User interactions (clicks, hovers, etc.) - Transition animations - Component variant states - User flows and navigation
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| -------------------- | ------- | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | — | Required. The unique file key from a Figma URL. To find it: from a URL like '' or '', extract the alphanumeric string after '/file/' or '/design/' (e.g., 'ABC123xyz'). This is typically 22 alphanumeric characters. |
| `analyze_components` | boolean | | — | Extract component variant states |
| `include_animations` | boolean | | — | Include detailed animation data |
***
### `Figma Get Activity Logs`
Integration name: **FIGMA\_GET\_ACTIVITY\_LOGS**
Retrieves activity log events from Figma, allowing filtering by event types, time range, and pagination.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------- | :------: | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `limit` | integer | | — | Maximum number of events per response, for pagination. If unspecified, defaults to 1000. |
| `order` | string | | — | Sort order for events by timestamp. |
| `events` | string | | `"file_viewed,file_commented"` | Comma-separated event types to include. If unspecified, all event types are returned. Refer to Figma's API documentation for a comprehensive list. |
| `end_time` | integer | | — | Unix timestamp for the latest time for events. If unspecified, defaults to the current timestamp. |
| `start_time` | integer | | — | Unix timestamp for the earliest time for events. If unspecified, defaults to one year ago. |
***
### `Figma Get A Webhook`
Integration name: **FIGMA\_GET\_A\_WEBHOOK**
Retrieves detailed information about a specific webhook by its ID, provided the webhook exists and is accessible to the user.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | ---------------------- | ------------------------------------------------- |
| `webhook_id` | string | ✅ | `"782561836293761926"` | The unique identifier of the webhook to retrieve. |
***
### `Figma Get Comments In A File`
Integration name: **FIGMA\_GET\_COMMENTS\_IN\_A\_FILE**
Retrieves all comments from an existing Figma file, identified by a valid `file_key`, returning details like content, author, position, and reactions, with an option for Markdown formatted content.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------- | :------: | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `as_md` | boolean | | `"true"` | If true, comment content will be returned in Markdown format where applicable (e.g., for links, bold text). Defaults to false, returning rich text structure. |
| `file_key` | string | ✅ | `"jV2jZ7r9H6F1kY8LwQ3n"` | Identifier for the Figma file from which to retrieve comments. This can be a file key (a unique string identifying a file) or a branch key. To obtain a branch key, use the `GET /v1/files/:key` endpoint with the `branch_data` query parameter. |
***
### `Figma Get Component`
Integration name: **FIGMA\_GET\_COMPONENT**
DEPRECATED: Use FIGMA\_GET\_FILE\_NODES instead. Get component data with automatic simplification. Returns clean, AI-friendly component structure.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------------- | ------ | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `node_id` | string | ✅ | — | ID of the component node. Must be a component node ID specifically (not a frame or page ID); pass verbatim from sources like FIGMA\_GET\_FILE\_COMPONENTS. |
| `file_key` | string | ✅ | — | File key that contains the component |
| `response_detail` | string | | — | Level of detail in the response. 'minimal' (default) simplifies component data for AI consumption. 'full' returns the raw Figma API response. |
***
### `Figma Get Component2`
Integration name: **FIGMA\_GET\_COMPONENT2**
Fetches metadata for a specific component using its unique identifier. Use when you need to retrieve published component details from a team library.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------- | ------ | :------: | -------------------------------------------- | --------------------------------------- |
| `key` | string | ✅ | `"dbe971cca11feeb98c3c74357bdc4d20678f2f88"` | The unique identifier of the component. |
***
### `Figma Get Component Set`
Integration name: **FIGMA\_GET\_COMPONENT\_SET**
Retrieves detailed metadata for a specific published Figma component set using its unique `key`.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------- | ------ | :------: | -------------------------- | ------------------------------------------- |
| `key` | string | ✅ | `"NsklHwLekg2Y09ChsX0VIN"` | The unique identifier of the component set. |
***
### `Figma Get Current User`
Integration name: **FIGMA\_GET\_CURRENT\_USER**
Retrieves detailed information for the currently authenticated Figma user.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.*
***
### `Figma Get Dev Resources`
Integration name: **FIGMA\_GET\_DEV\_RESOURCES**
Retrieves development resources (e.g., Jira/GitHub links) for a Figma main file, optionally filtering by specific node IDs.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | -------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"dAln0zQzF2xXyZc8V9bA6e"` | The unique identifier of the Figma design file from which to retrieve development resources. This must be the key for a main file, not a branch key. Extract the file\_key from Figma URLs: figma.com/design/{file\_key}/... or figma.com/file/{file\_key}/... |
| `node_ids` | string | | `"1:2,100:54"` | A comma-separated string of node IDs to filter dev resources. Example: '1:2,100:54'. If omitted, returns all dev resources in the file. |
***
### `Figma Get File Components`
Integration name: **FIGMA\_GET\_FILE\_COMPONENTS**
Retrieves published components from a Figma file, which must be a main file (not a branch) acting as a library.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"your_figma_file_key"` | Key of the Figma file. This file must be a main file (not a branch key) that acts as a library, as components are published from main files. |
***
### `Figma Get File Component Sets`
Integration name: **FIGMA\_GET\_FILE\_COMPONENT\_SETS**
Retrieves all published component sets from the specified Figma main file (file\_key must not be for a branch).
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"ABC123xyz"` | Key of the Figma file. Must be a main file key (not a branch key) as component sets are published from main files. Extract from Figma URL: ... or ... |
***
### `Figma Get File Json`
Integration name: **FIGMA\_GET\_FILE\_JSON**
Get Figma Design file data with automatic simplification. IMPORTANT: Only supports Design files (figma.com/design/{file\_key}). FigJam board files (figma.com/board/{file\_key}) and Slides files (figma.com/slides/{file\_key}) are NOT supported and will return a 400 error: "File type not supported by this endpoint". This enhanced version automatically transforms verbose Figma JSON into clean, AI-friendly format with: - CSS-like property names - Deduplicated variables - Removed empty values - 70%+ size reduction Use simplify=False to get raw API response.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------------- | ------- | :------: | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ids` | string | | — | Comma-separated node IDs to fetch specific nodes (uses /nodes endpoint). Node IDs can be extracted from Figma URLs: figma.com/design/{file\_key}/{name}?node-id={node\_id}. Example: '1:2,1:3' for multiple nodes. Must be a string, not an array — passing an array causes validation failure. URL node IDs use hyphens (e.g., '1-2'); convert to colons (e.g., '1:2') before passing here. |
| `depth` | integer | | — | Tree traversal depth (e.g., 2 for pages and top-level children). Omitting depth on large files can produce extremely large responses or timeouts; scope with `ids` and set depth to the minimum needed. |
| `version` | string | | — | Specific version ID; current version if omitted |
| `file_key` | string | ✅ | — | File key extracted from a Figma Design file URL. SUPPORTED: figma.com/design/{file\_key}/... or figma.com/file/{file\_key}/... NOT SUPPORTED: FigJam boards (figma.com/board/{file\_key}) and Slides (figma.com/slides/{file\_key}). Example valid key: 'abc123XYZ' from URL figma.com/design/abc123XYZ/My-Design. |
| `geometry` | string | | — | Set to "paths" to include vector data |
| `branch_data` | boolean | | — | Include branch metadata |
| `plugin_data` | string | | — | Comma-separated plugin IDs to include plugin data |
| `response_detail` | string | | — | Level of detail in the response. 'minimal' (default) simplifies file data for AI consumption. 'full' returns the raw Figma API response. |
***
### `Figma Get File Metadata`
Integration name: **FIGMA\_GET\_FILE\_METADATA**
Get Figma file metadata including name, creator, last modification details, thumbnail, and access information. Use when you need quick file overview without the full document tree.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `file_key` | string | ✅ | `"VGULlnz44R0Ooe4FZKDxlhh4"` | File key to get metadata for. This can be a file key or branch key. Extract from file URL: ... or ... Use `GET /v1/files/:key` with the `branch_data` query param to get the branch key. |
***
### `Figma Get File Nodes`
Integration name: **FIGMA\_GET\_FILE\_NODES**
Fetch JSON for specific node IDs from a Figma file to avoid full-file payload limits. Use when you already know target node IDs (from shallow file fetch or component listings) or when full-file JSON has hit payload limits. Prefer depth=1 for fast discovery.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------- | ------- | :------: | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `ids` | — | ✅ | `"1:5,1:6"` | Node IDs to retrieve. Provide as comma-separated string (e.g., '1:5,1:6') or as list of strings (e.g., \['1:5', '1:6']). Use this when you already know target node IDs from a shallow file fetch or component/style listings. |
| `depth` | integer | | `1` | How deep into each requested node subtree to traverse. Use depth=1 for fast structure discovery (only immediate children), increase only when needed. Omit to get full subtree. |
| `version` | string | | `"1234567890"` | Specific version ID to retrieve. Omit for current version. |
| `file_key` | string | ✅ | `"abc123XYZ"` | Figma file key or branch key extracted from URL. Example: 'abc123XYZ' from figma.com/design/abc123XYZ/My-Design. |
| `geometry` | string | | `"paths"` | Set to 'paths' to include vector path data in the response. Omit for standard node data without geometry. |
| `plugin_data` | string | | `"shared"` | Plugin IDs (comma-separated) or 'shared' to include plugin data. Omit to exclude plugin data. |
***
### `Figma Get Files In A Project`
Integration name: **FIGMA\_GET\_FILES\_IN\_A\_PROJECT**
Fetches a list of files in a Figma project, optionally including branch metadata.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------- | ------- | :------: | ------------- | ------------------------------------------------------------ |
| `project_id` | string | ✅ | `"PJ7b3k2N5"` | Identifier of the Figma project, typically found in its URL. |
| `branch_data` | boolean | | `"true"` | If true, includes metadata for branches of main files. |
***
### `Figma Get File Styles`
Integration name: **FIGMA\_GET\_FILE\_STYLES**
Retrieves a list of published styles (like colors, text attributes, effects, and layout grids) from a specified main Figma file (not a branch).
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"VGULlnz44R0Ooe4FZKDxlhh4"` | Key of the main Figma file (not a branch) from which to retrieve published styles. Extract the file\_key from the Figma URL: figma.com/design/{file\_key}/... or figma.com/file/{file\_key}/... Note: This endpoint only returns PUBLISHED styles from team libraries. For local/unpublished styles, use FIGMA\_GET\_FILE\_JSON instead. |
***
### `Figma Get Image Fills`
Integration name: **FIGMA\_GET\_IMAGE\_FILLS**
Retrieves temporary (14-day expiry) download URLs for all image fills in a Figma file; requires `imageRef` from `Paint` objects to map URLs.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"sFHgQh9dL6369o5wrZHmdR"` | The unique identifier of a Figma file. Extract this from Figma URLs: ... or ... The file\_key is a 22-character alphanumeric string (e.g., 'sFHgQh9dL6369o5wrZHmdR'). |
***
### `Figma Get Library Analytics Component Action Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_COMPONENT\_ACTION\_DATA**
Retrieves component insertion and detachment analytics for a specified Figma library, groupable by 'component' or 'team' and filterable by a date range (YYYY-MM-DD).
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | | — | Opaque cursor for pagination, from a previous response's `cursor` field; omit for the first page. |
| `end_date` | string | | `"2023-12-31"` | End date (YYYY-MM-DD) for analytics. Data includes up to end of this date's week. Defaults to latest computed week. |
| `file_key` | string | ✅ | `"sFglL9l62Z1c4qjX2LmyxK"` | Unique identifier (key) of the Figma library file to retrieve analytics data from. Must be a published library file from an Enterprise plan organization. |
| `group_by` | string | ✅ | `"component"` | Dimension to group analytics: 'component' or 'team'. |
| `start_date` | string | | `"2023-01-01"` | Start date (YYYY-MM-DD) for analytics. Data includes from start of this date's week. Defaults to one year prior. |
***
### `Figma Get Library Analytics Component Usage Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_COMPONENT\_USAGE\_DATA**
Retrieves component usage analytics for a specified Figma library file (identified by `file_key`), with data groupable by 'component' or 'file'.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | | — | Opaque string for pagination to fetch the next page of data, obtained from a previous response. |
| `file_key` | string | ✅ | `"your_figma_file_key"` | Unique identifier (key) of the Figma library file. Must be a published library file from an Enterprise plan organization. |
| `group_by` | string | ✅ | `"component"` | Dimension to group analytics data, affecting the response `rows` structure. Use 'component' to see per-component usage stats, or 'file' to see which files use the library. |
***
### `Figma Get Library Analytics Style Action Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_STYLE\_ACTION\_DATA**
Retrieves style usage analytics (insertions, detachments) for a Figma library, grouped by 'style' or 'team'; if providing a date range, ensure end\_date is not before start\_date.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | | `"MTY3ODg4NjQwMDAwMA=="` | Opaque cursor for pagination, from a previous response's `cursor` field to fetch the next page; omit for first page. |
| `end_date` | string | | `"2023-12-31"` | End date for the analytics data range (YYYY-MM-DD). Data includes up to the end of this date's week. Defaults to the most recently computed week if unspecified. |
| `file_key` | string | ✅ | `"Hx0k0N9mC9SikO0hZ4C4sC"` | Unique identifier (key) of the Figma library. Must be a published library file from an Enterprise plan organization. |
| `group_by` | string | ✅ | `"style"` | Dimension by which to group the library style analytics data. Use 'style' for per-style metrics or 'team' for per-team metrics. |
| `start_date` | string | | `"2023-01-01"` | Start date for the analytics data range (YYYY-MM-DD). Data includes from the start of this date's week. Defaults to one year prior if unspecified. |
***
### `Figma Get Library Analytics Style Usage Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_STYLE\_USAGE\_DATA**
Retrieves style usage analytics for a published Figma library. Returns data about how styles (colors, text styles, effects, grids) from the library are being used across your organization. Requires Enterprise plan and library\_analytics:read scope. Group results by 'style' to see per-style metrics or by 'file' to see which files use the library's styles.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cursor` | string | | — | Pagination cursor from a previous response's 'cursor' field. Omit to get the first page of results. |
| `file_key` | string | ✅ | — | The unique file key of a published Figma library. Obtain this from the library URL (e.g., figma.com/file/FILE\_KEY/...) or via the Get Team Styles endpoint. Note: This API is only available on Enterprise plans. |
| `group_by` | string | ✅ | `"style"` | How to group the analytics data: 'style' returns usage stats per style, 'file' returns usage stats per file using the library. |
***
### `Figma Get Library Analytics Variable Action Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_VARIABLE\_ACTION\_DATA**
Retrieves weekly, paginated analytics data on variable insertions and detachments for a specified Figma library (identified by `file_key`), groupable by 'variable' or 'team', and filterable by an optional date range. Note: Requires Enterprise plan and library\_analytics:read scope.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `cursor` | string | | — | Opaque cursor for pagination from a previous response; omit or use null for the first page. |
| `end_date` | string | | `"2023-12-31"` | End date (YYYY-MM-DD) for the analytics range. Data is aggregated weekly; this date rounds to the nearest week end. Defaults to the latest computed week if unspecified. |
| `file_key` | string | ✅ | — | Unique identifier (key) of the Figma file (library) for which to retrieve variable analytics data. |
| `group_by` | string | ✅ | `"team"` | Dimension to group analytics data, which determines the structure of `rows` in the response. |
| `start_date` | string | | `"2023-01-01"` | Start date (YYYY-MM-DD) for the analytics range. Data is aggregated weekly; this date rounds to the nearest week start. Defaults to one year prior if unspecified. |
***
### `Figma Get Library Analytics Variable Usage Data`
Integration name: **FIGMA\_GET\_LIBRARY\_ANALYTICS\_VARIABLE\_USAGE\_DATA**
Retrieves paginated analytics data on variable usage from a specified Figma library, grouped by 'file' or 'variable', for libraries with enabled analytics.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | | `"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."` | Opaque cursor for pagination, from a previous response's `cursor` field if `next_page` was true. Omit for the first page. |
| `file_key` | string | ✅ | `"sFglL9l62Z1c4qjX2LmyxK"` | Key of the Figma library file (from its URL) for which to retrieve variable usage analytics. Must be a published library from an Enterprise plan organization. |
| `group_by` | string | ✅ | `"file"` | Dimension for grouping analytics data, determining the structure of `rows` in the response ('file' or 'variable'). |
***
### `Figma Get Local Variables`
Integration name: **FIGMA\_GET\_LOCAL\_VARIABLES**
Retrieves all local/remote variables for a Figma file/branch; crucial for obtaining mode-specific values which `/v1/files/{file_key}/variables/published` omits.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | `"your_file_key"` | Key of the Figma file or branch. Can be a standard file key or a branch-specific key (to obtain a branch key, use `GET /v1/files/:key` with the `branch_data` query parameter). |
***
### `Figma Get Payments`
Integration name: **FIGMA\_GET\_PAYMENTS**
Retrieves a user's payment information for a Figma plugin, widget, or Community file; the authenticated identity must own the resource.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------------------- | ------- | :------: | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | integer | | — | ID of the user whose payment information is sought. Obtain via OAuth2 with Figma REST API. Required if `plugin_payment_token` is not provided. |
| `plugin_id` | integer | | — | ID of the plugin. Obtain from its manifest or Community page URL (number after 'plugin/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`. |
| `widget_id` | integer | | — | ID of the widget. Obtain from its manifest or Community page URL (number after 'widget/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`. |
| `community_file_id` | integer | | — | ID of the Community file. Obtain from its Community page URL (number after 'file/'). If `user_id` is provided, specify exactly one of `community_file_id`, `plugin_id`, or `widget_id`. |
| `plugin_payment_token` | string | | — | Short-lived auth token from `getPluginPaymentTokenAsync` (Figma Plugin Payments API). See Figma docs 'Calling the Payments REST API...'. If provided, `user_id` and resource IDs are typically not needed. |
***
### `Figma Get Projects In A Team`
Integration name: **FIGMA\_GET\_PROJECTS\_IN\_A\_TEAM**
Retrieves projects within a specified Figma team that are visible to the authenticated user.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------- | ------ | :------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `team_id` | string | ✅ | `"8765432109876543210"` | Identifier of the Figma team from which to list projects. Note: The `team_id` cannot be programmatically obtained solely from a user token. To find a `team_id`, navigate to a team page you are a member of in Figma. The `team_id` will be present in the URL, typically formatted as `https://www.figma.com/files/team/YOUR_TEAM_ID/Your_Team_Name`. |
***
### `Figma Get Published Variables`
Integration name: **FIGMA\_GET\_PUBLISHED\_VARIABLES**
Retrieves variables published from a specified Figma file; this API is available only to full members of Enterprise organizations.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ---------- | ------ | :------: | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `file_key` | string | ✅ | — | The key of the Figma file from which to retrieve published variables. This must be a main file's key, not a branch key, as publishing from branches is not supported. |
***
### `Figma Get Reactions For A Comment`
Integration name: **FIGMA\_GET\_REACTIONS\_FOR\_A\_COMMENT**
Retrieves reactions for a specific comment in a Figma file.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `cursor` | string | | `"opaque_cursor_string_from_previous_response"` | Pagination cursor from `next_page` of a previous response. Omit or use null for the first page. |
| `file_key` | string | ✅ | `"your_figma_file_key"` | Key for the Figma file or branch. Can be a file key (from URL) or a branch key. To get a branch key, use `GET /v1/files/:key` with the `branch_data` query parameter. |
| `comment_id` | string | ✅ | `"1234567890"` | Identifier of the comment. |
***
### `Figma Get Scim Service Provider Config`
Integration name: **FIGMA\_GET\_SCIM\_SERVICE\_PROVIDER\_CONFIG**
Get Figma's SCIM service provider configuration. Returns configuration details including which SCIM operations are supported (patch, bulk, filter, etc.), authentication schemes, and service capabilities.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called. *No parameters required.*
***
### `Figma Get Style`
Integration name: **FIGMA\_GET\_STYLE**
Retrieves detailed metadata for a specific style in Figma using its unique style key.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------- | ------ | :------: | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `key` | string | ✅ | `"fab4c1a7ca2a72b01100db66097790979f3655c4"` | The unique identifier (key) of the style to retrieve. Style keys are 40-character hexadecimal hash strings obtained from the GET /v1/files/{file\_key}/styles or GET /v1/teams/{team\_id}/styles endpoints. This endpoint only works for styles published in a team library. |
***
### `Figma Get Team Components`
Integration name: **FIGMA\_GET\_TEAM\_COMPONENTS**
Retrieves components published in a specific Figma team's library; the team must have published components, otherwise an empty list is returned.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------- | ------- | :------: | ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | integer | | `"1609459200000"` | Opaque cursor indicating the point after which to retrieve components. Used for pagination. Exclusive with the `before` parameter. The cursor value is an internally tracked integer that doesn't correspond to any specific Figma IDs. |
| `before` | integer | | `"1609459300000"` | Opaque cursor indicating the point before which to retrieve components. Used for pagination. Exclusive with the `after` parameter. The cursor value is an internally tracked integer that doesn't correspond to any specific Figma IDs. |
| `team_id` | string | ✅ | `"876543210987654321"` | The unique identifier of the Figma team from which to retrieve published components. IMPORTANT: Team IDs cannot be obtained programmatically via the Figma API. To find your team\_id: navigate to your team page in the Figma web app (), the team\_id is the numeric string after '/team/' in the URL. |
| `page_size` | integer | | `"30"` | Number of components to return per page. Maximum value is 1000. |
***
### `Figma Get Team Component Sets`
Integration name: **FIGMA\_GET\_TEAM\_COMPONENT\_SETS**
Retrieves a paginated list of published component sets (collections of reusable UI elements) from a specified Figma team's library.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------- | ------- | :------: | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | integer | | `"0"` | Cursor for pagination, indicating the point after which to retrieve component sets. Exclusive with the 'before' parameter. The cursor value is an internally tracked integer and does not correspond to any specific Figma IDs. |
| `before` | integer | | `"1609459300"` | Cursor for pagination, indicating the point before which to retrieve component sets. Exclusive with the 'after' parameter. The cursor value is an internally tracked integer and does not correspond to any specific Figma IDs. |
| `team_id` | string | ✅ | `"1234567890123456789"` | The unique identifier of the Figma team from which to list component sets. IMPORTANT: Team IDs cannot be obtained programmatically via the Figma API. To find your team\_id: navigate to your team page in the Figma web app (), the team\_id is the numeric string after '/team/' in the URL. |
| `page_size` | integer | | `"30"` | Number of component sets to return in a single page. |
***
### `Figma Get Team Styles`
Integration name: **FIGMA\_GET\_TEAM\_STYLES**
Retrieves a paginated list of published styles (fill colors, text styles, effects, grids) from a specified Figma team's library. Note: The team must have published styles in its library for this endpoint to return data. Teams without published styles will return an empty list.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------- | ------- | :------: | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `after` | integer | | `1609459200000` | Opaque integer cursor to retrieve styles after this point; use `cursor.after` from a previous response. Mutually exclusive with `before` - only one can be specified. |
| `before` | integer | | `1234560000000` | Opaque integer cursor to retrieve styles before this point; use `cursor.before` from a previous response. Mutually exclusive with `after` - only one can be specified. |
| `team_id` | string | ✅ | `"1234567890123456789"` | Identifier of the Figma team to retrieve published styles from. Note: The team\_id cannot be obtained programmatically via the API. To find a team\_id, navigate to the team page in Figma () and extract the numeric ID from the URL. |
| `page_size` | integer | | `30` | Number of style items to return per page. Maximum supported value is 100. |
***
### `Figma Get Team Webhooks`
Integration name: **FIGMA\_GET\_TEAM\_WEBHOOKS**
Retrieves all webhooks registered for a specified Figma context (team, project, or file). Uses the Figma Webhooks V2 API endpoint (GET /v2/webhooks) with context and context\_id query parameters. This is the recommended approach as the legacy path-based endpoint (/v2/teams/{team\_id}/webhooks) is deprecated. Note: team\_id, project\_id, and file\_key cannot be discovered programmatically via the API. Extract them from Figma URLs or use FIGMA\_DISCOVER\_FIGMA\_RESOURCES to parse URLs.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `context` | string | | `"team"` | The context type to query webhooks for. Options: 'team', 'project', or 'file'. Defaults to 'team' for backward compatibility. |
| `context_id` | string | ✅ | `"1170245155647481265"` | The ID of the context to query webhooks for. For 'team' context, this is the team\_id. For 'project' context, this is the project\_id. For 'file' context, this is the file\_key. Note: team\_id cannot be programmatically obtained from the API - extract it from your Figma team URL: |
***
### `Figma Get Versions Of A File`
Integration name: **FIGMA\_GET\_VERSIONS\_OF\_A\_FILE**
Retrieves the version history for a Figma file or branch, as specified by its `file_key`.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ----------- | ------- | :------: | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `after` | integer | | `"1588291200"` | Version ID for pagination; retrieves versions created strictly after this ID. |
| `before` | integer | | `"1609459200"` | Version ID for pagination; retrieves versions created strictly before this ID. |
| `file_key` | string | ✅ | `"sFHgQh9dL6369o5wrZHmdR"` | The key of the Figma file or branch from which to retrieve the version history. Extract from file URL: ... or ... For branch keys, use `GET /v1/files/:key` with the `branch_data` query param to obtain it. The authenticated user must have access to the file; otherwise a 404 'Not found' error is returned. |
| `page_size` | integer | | `"30"` | Number of version items per page. The API defaults to 30 if this parameter is not sent. |
***
### `Figma Get Webhook Requests`
Integration name: **FIGMA\_GET\_WEBHOOK\_REQUESTS**
Retrieves a history of webhook requests for a specific Figma webhook subscription; data is available for requests sent within the last seven days.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------ | ------ | :------: | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `webhook_id` | string | ✅ | `"1234567890"` | The unique identifier of the Figma webhook subscription for which to retrieve past event requests. This refers to the ID of the webhook itself, not an individual event. |
***
### `Figma Render Images Of File Nodes`
Integration name: **FIGMA\_RENDER\_IMAGES\_OF\_FILE\_NODES**
Render Figma nodes as images (PNG, JPG, SVG, PDF). Returns a map of node IDs to temporary image URLs (valid for 30 days). Images are capped at 32 megapixels; larger requests are automatically scaled down. REQUIRED PARAMETERS: - file\_key: Figma file key from URL (e.g., 'abc123XYZ' from figma.com/design/abc123XYZ/...) - ids: Comma-separated node IDs to render (e.g., '1:2' or '1:2,1:3,1:4') NODE IDs: Found in Figma URLs after 'node-id=' or from FIGMA\_GET\_FILE\_JSON response. FORMATS: - png/jpg: Raster images with optional scale (0.01-4.0) - svg: Vector graphics with text outline options - pdf: Document format COMMON ISSUES: - null value in images map = node failed to render (invalid ID, invisible, 0% opacity) - 404 error = file\_key not found or no access - 429 error = rate limit exceeded, wait and retry
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------------------- | ------- | :------: | ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ids` | string | ✅ | `"1:2"` | Comma-separated list of node IDs to render as images. Node IDs are found in Figma URLs after 'node-id=' (e.g., '1:2') or from FIGMA\_GET\_FILE\_JSON response. Example: '1:2,1:3,1:4'. |
| `scale` | number | | `1` | Image scaling factor between 0.01 and 4.0. Example: 2.0 renders at 2x resolution. Applies to PNG/JPG only; ignored for SVG/PDF. |
| `format` | string | | `"png"` | Output image format: 'png', 'jpg', 'svg', or 'pdf'. |
| `version` | string | | `"3423423523401204902"` | Specific version ID of the file to render. If omitted, uses current version. |
| `file_key` | string | ✅ | `"abc123XYZ"` | Key of the Figma file or branch. Extract from Figma URLs: figma.com/design/{file\_key}/... or figma.com/file/{file\_key}/... For branch keys, use GET /v1/files/:key with branch\_data=true. |
| `contents_only` | boolean | | — | If true, excludes content that overlaps node boundaries. If false, includes overlapping content (may increase processing time). |
| `svg_include_id` | boolean | | — | (SVG only) If true, includes 'id' attributes (using layer names) on SVG elements. |
| `svg_outline_text` | boolean | | — | (SVG only) If true, text renders as vector paths (outlines) for exact visual fidelity. If false, text renders as elements (selectable, but appearance may vary by system fonts). |
| `svg_include_node_id` | boolean | | — | (SVG only) If true, adds 'data-node-id' attribute (with Figma node ID) to SVG elements. |
| `svg_simplify_stroke` | boolean | | — | (SVG only) If true, simplifies strokes using 'stroke' attribute instead of . |
| `use_absolute_bounds` | boolean | | — | If true, uses full node dimensions ignoring cropping/empty space. Useful for text nodes to avoid unintended cropping. |
***
### `Figma Update A Webhook`
Integration name: **FIGMA\_UPDATE\_A\_WEBHOOK**
Updates an existing Figma webhook, identified by `webhook_id`, allowing modification of its event type, endpoint, passcode, status, or description.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| ------------- | ------ | :------: | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `status` | string | | `"ACTIVE"` | Operational status: `ACTIVE` to receive events, `PAUSED` to temporarily stop event delivery. Optional - only provide to change status. |
| `endpoint` | string | | `"https://example.com/figma-webhook-receiver"` | URL of the HTTPS endpoint to receive POST requests for webhook events. Max length 2048. Optional - only provide to change the endpoint. |
| `passcode` | string | | `"secure-passcode-123"` | Secret string for your endpoint to verify webhook authenticity. Max length 100. Optional - only provide to change the passcode. |
| `event_type` | string | | `"FILE_UPDATE"` | Type of event that triggers the webhook. Optional - only provide to change the event type. |
| `webhook_id` | string | ✅ | `"7891234560"` | Unique identifier of the existing webhook to update. Obtain from GET team webhooks or after creating a webhook. |
| `description` | string | | `"Webhook for project Alpha updates"` | User-friendly description for the webhook. Max length 140 characters. Pass empty string to remove. Optional. |
***
### `Figma Update Dev Resources`
Integration name: **FIGMA\_UPDATE\_DEV\_RESOURCES**
Updates the name and/or URL of one or more existing Figma Dev Resources, each identified by its unique `id`.
#### Parameters
Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.
| Parameter | Type | Required | Example | Description |
| --------------- | ----- | :------: | ------- | ----------------------------------------------------------------------------------------------------------------- |
| `dev_resources` | array | ✅ | — | List of dev resources to update. Each must include its `id` and can optionally provide a new `name` and/or `url`. |
***
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://docs.toolhouse.ai/toolhouse/integrations/figma.md?ask=
```
The question should be specific, self-contained, and written in natural language.
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.