Figma API
Tools that enable LLMs to interact directly with the figma API.
Arcade Toolkit for Figma API empowers LLMs to seamlessly interact with Figma projects. This toolkit provides a robust set of capabilities for managing design assets, comments, and webhooks within Figma.
Capabilities
- Manage comments, including adding, deleting, and reacting to them.
- Create, update, and delete developer resources in bulk across multiple Figma files.
- Access and manipulate Figma components, styles, and variables for efficient asset management.
- Fetch analytics data and version histories to analyze design changes and usage trends.
- Integrate webhooks for real-time updates on design changes and events.
OAuth
- Provider: Figma
- Scopes: current_user:read, file_comments:read, file_comments:write, file_content:read, file_dev_resources:read, file_dev_resources:write, file_metadata:read, file_variables:read, file_variables:write, file_versions:read, library_analytics:read, library_assets:read, library_content:read, projects:read, team_library_content:read, webhooks:read, webhooks:write
Available tools(43)
| Tool name | Description | Secrets | |
|---|---|---|---|
Posts a new comment on a Figma file.
Use this tool to post a new comment on a specified file in Figma, identified by file_key.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Add a reaction to a comment on a Figma file.
Use this tool to post a new reaction to an existing comment on a Figma file. It should be called when you want to react to a specific comment in a Figma project.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
This operation also requires path parameters.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
Note: You must also provide the required path parameters when executing.
If you need the schema, call with mode='get_request_schema' ONCE, then execute.
| |||
Update multiple Figma dev resources in bulk.
This tool updates developer resources across multiple Figma files. It should be called when you need to apply changes to several resources at once. The response will include arrays indicating which resources were successfully updated and which encountered errors.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Bulk create developer resources in multiple Figma files.
Use this tool to create multiple developer resources across different Figma files. Successfully created resources will be listed in the response, while any errors will also be provided, indicating issues such as non-existent file keys or duplicate URLs.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Create a new webhook for Figma events.
This tool creates a webhook in Figma that triggers an event to a specified endpoint. It sends a PING event by default, unless set to PAUSED, and can be reactivated later.
Note: Understanding the request schema is necessary to properly create
the stringified JSON input object for execution.
Modes:
- GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't
already have it. Do NOT call repeatedly if you already received
the schema.
- EXECUTE: Performs the operation with the provided request body
JSON.
If you need the schema, call with mode='get_request_schema' ONCE, then execute. | |||
Delete a dev resource from a Figma file.
Call this tool to delete a specific developer resource from a Figma file using the file key and resource ID. | |||
Delete your comment from a Figma file.
Use this tool to delete a specific comment you made on a Figma file. Only the original commenter can delete their comments. | |||
Delete a specified webhook in Figma.
Use this tool to delete a specified webhook in Figma. This action is irreversible and should be called when a webhook is no longer needed. | |||
Deletes your specific comment reaction in Figma.
This tool allows users to delete a reaction they added to a comment in a Figma file. It can only be used if the reaction was made by the person attempting to delete it. | |||
Retrieve reactions from a specific comment in Figma.
Use this tool to obtain a list of reactions left on a specific comment in a Figma file. This can help track engagement or feedback on comments. | |||
Fetch library analytics component usage data by dimension.
This tool retrieves a list of library analytics component usage data, providing insights into how components are used, broken down by the specified dimension. | |||
Retrieve a Figma file as a JSON object using its file key.
Use this tool to fetch a Figma document as JSON, identified by a file key. The returned data includes the document structure and metadata about components. | |||
Fetch the version history of a Figma file.
Use this tool to obtain the version history of a specific Figma file, enabling the analysis of its changes over time. This can be useful for reviewing past edits or rendering specific versions. | |||
Retrieve download links for images in a Figma document.
Use this tool to get download links for all images present in the image fills of a Figma document. These links allow access to images users have added to their design files. The URLs will expire after about 14 days and can be found using image references. | |||
Retrieve library analytics variable actions data from Figma.
Call this tool to obtain a breakdown of library analytics variable actions data from Figma based on a specific dimension. | |||
Fetch all projects within a specified Figma team.
This tool retrieves a list of projects for a specified team in Figma, visible to the authenticated user. | |||
Retrieve development resources from a Figma file.
Use this tool to gather development resources from a specific Figma file using the file key. | |||
Retrieve metadata for a Figma component by key.
Use this tool to obtain detailed metadata about a specific Figma component using its key. | |||
Retrieve metadata for a Figma component set using its key.
Use this tool to obtain detailed metadata about a published component set in Figma by providing its unique key identifier. | |||
Retrieve comments from a Figma file.
Use this tool to get a list of comments left on a specific Figma file. It is useful for accessing feedback or discussions related to file elements. | |||
Retrieve published components from a Figma file library.
Use this tool to obtain a list of all published components within a specific Figma file, allowing for design asset management or analysis. | |||
Retrieve nodes and metadata from a Figma file.
Use this tool to get detailed information about specific nodes in a Figma file, including metadata like name, last modified date, thumbnail URL, editor type, version, and link access permissions. Also retrieves document structure, component mappings, and styles. Useful for accessing and analyzing Figma design elements. | |||
Retrieve all files from a specific Figma project.
This tool fetches a list of all files within the specified Figma project. Use it when you need to access or manage project files stored in Figma. | |||
Retrieve a Figma webhook by its ID.
Use this tool to obtain detailed information about a specific Figma webhook by providing its unique ID. | |||
Retrieve a list of webhooks from Figma.
Call this tool to get a list of webhooks available in your Figma context or plan. This can be used to manage and view all the webhooks you have access to, with results provided in a paginated format. |
Selected tools
No tools selected.
Click "Show all tools" to add tools.
Requirements
Select tools to see requirements
FigmaApi.AddCommentToFigmaFile
Posts a new comment on a Figma file. Use this tool to post a new comment on a specified file in Figma, identified by file_key. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
figma_file_key | string | Optional | File or branch key for the Figma file where the comment will be added. Retrieve this using `GET /v1/files/:key` with the `branch_data` query param for branch keys. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postComment'.FigmaApi.AddFigmaCommentReaction
Add a reaction to a comment on a Figma file. Use this tool to post a new reaction to an existing comment on a Figma file. It should be called when you want to react to a specific comment in a Figma project. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
file_or_branch_key | string | Optional | Key of the file or branch where the comment reaction should be posted. Can be obtained via the Figma API. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
comment_id | string | Optional | The unique identifier of the comment you want to react to in a Figma file. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postCommentReaction'.FigmaApi.BulkUpdateFigmaDevResources
Update multiple Figma dev resources in bulk. This tool updates developer resources across multiple Figma files. It should be called when you need to apply changes to several resources at once. The response will include arrays indicating which resources were successfully updated and which encountered errors. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putDevResources'.FigmaApi.CreateBulkDevResources
Bulk create developer resources in multiple Figma files. Use this tool to create multiple developer resources across different Figma files. Successfully created resources will be listed in the response, while any errors will also be provided, indicating issues such as non-existent file keys or duplicate URLs. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postDevResources'.FigmaApi.CreateFigmaWebhook
Create a new webhook for Figma events. This tool creates a webhook in Figma that triggers an event to a specified endpoint. It sends a PING event by default, unless set to PAUSED, and can be reactivated later. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postWebhook'.FigmaApi.DeleteDevResource
Delete a dev resource from a Figma file. Call this tool to delete a specific developer resource from a Figma file using the file key and resource ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
target_file_key | string | Required | The main file key from which to delete the dev resource. Must not be a branch key. |
dev_resource_id | string | Required | The ID of the developer resource to delete from the Figma file. |
Requirements
Output
json— Response from the API endpoint 'deleteDevResource'.FigmaApi.DeleteFigmaComment
Delete your comment from a Figma file. Use this tool to delete a specific comment you made on a Figma file. Only the original commenter can delete their comments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
figma_file_key | string | Required | The file or branch key from which to delete the comment. Use `GET /v1/files/:key` with `branch_data` to obtain the branch key. |
comment_identifier | string | Required | The ID of the comment you wish to delete from the Figma file. Only the original commenter can perform this action. |
Requirements
Output
json— Response from the API endpoint 'deleteComment'.FigmaApi.DeleteFigmaWebhook
Delete a specified webhook in Figma. Use this tool to delete a specified webhook in Figma. This action is irreversible and should be called when a webhook is no longer needed.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_id_to_delete | string | Required | The unique identifier of the webhook you wish to delete. This ID is required for the deletion operation. |
Requirements
Output
json— Response from the API endpoint 'deleteWebhook'.FigmaApi.DeleteMyCommentReaction
Deletes your specific comment reaction in Figma. This tool allows users to delete a reaction they added to a comment in a Figma file. It can only be used if the reaction was made by the person attempting to delete it.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
reaction_emoji | string | Required | The emoji associated with the reaction to be deleted. Only the emoji used for the reaction you added can be deleted. |
file_or_branch_key | string | Required | Key of the Figma file or branch where the reaction should be deleted. Use `GET /v1/files/:key` with the `branch_data` query param to obtain the branch key if needed. |
comment_id | string | Required | The ID of the comment from which you want to delete your reaction. |
Requirements
Output
json— Response from the API endpoint 'deleteCommentReaction'.FigmaApi.FetchCommentReactions
Retrieve reactions from a specific comment in Figma. Use this tool to obtain a list of reactions left on a specific comment in a Figma file. This can help track engagement or feedback on comments.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_or_branch_key | string | Required | The key for the file or branch to retrieve the comment reactions from in Figma. |
comment_id | string | Required | ID of the comment from which to retrieve reactions. |
pagination_cursor | string | Optional | Cursor for pagination. Use the cursor from the previous call's response to retrieve the next set of reactions. |
Requirements
Output
json— Response from the API endpoint 'getCommentReactions'.FigmaApi.FetchComponentUsageData
Fetch library analytics component usage data by dimension. This tool retrieves a list of library analytics component usage data, providing insights into how components are used, broken down by the specified dimension.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | A dimension to group the returned analytics data. Choose between 'component' or 'file'. |
library_file_key | string | Required | The file key of the library to fetch analytics data for. Required for specifying the target library. |
data_page_cursor | string | Optional | Cursor indicating which page of data to fetch, obtained from a prior API call. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsComponentUsages'.FigmaApi.FetchFigmaFile
Retrieve a Figma file as a JSON object using its file key. Use this tool to fetch a Figma document as JSON, identified by a file key. The returned data includes the document structure and metadata about components.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_key | string | Required | The unique key of the Figma file or branch to retrieve as JSON. |
version_id | string | Optional | Specify the version ID to retrieve a specific version of the file. Default is the current version. |
node_ids_of_interest | string | Optional | Comma-separated list of node IDs to retrieve specific parts of the Figma document. |
traversal_depth | number | Optional | Positive integer indicating the depth in the document tree to retrieve. For example, 1 returns only Pages; 2 returns Pages and top-level objects. |
export_vector_data | string | Optional | Set to "paths" to include vector data in the response. |
include_plugin_data | string | Optional | Comma separated list of plugin IDs and/or 'shared'. Includes plugin data in the result. |
include_branch_metadata | boolean | Optional | Set to true to include metadata about branches related to the file. If false, branch information will not be returned. |
Requirements
Output
json— Response from the API endpoint 'getFile'.FigmaApi.FetchFileVersionHistory
Fetch the version history of a Figma file. Use this tool to obtain the version history of a specific Figma file, enabling the analysis of its changes over time. This can be useful for reviewing past edits or rendering specific versions.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
target_file_key | string | Required | The key of the file or branch to fetch version history for. Use this to specify the Figma file whose version history you need. |
number_of_items_per_page | number | Optional | Specify the number of items to return per page. Defaults to 30 if not provided. |
get_versions_before_id | number | Optional | A version ID to get versions before it in the history. Used for pagination. |
after_version_id | number | Optional | Version ID to fetch subsequent versions. Used for pagination. Omit if not paginating. |
Requirements
Output
json— Response from the API endpoint 'getFileVersions'.FigmaApi.FetchImageFillLinks
Retrieve download links for images in a Figma document. Use this tool to get download links for all images present in the image fills of a Figma document. These links allow access to images users have added to their design files. The URLs will expire after about 14 days and can be found using image references.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_or_branch_key | string | Required | The file or branch key from which to retrieve image URLs. Use `GET /v1/files/:key` to get the branch key if needed. |
Requirements
Output
json— Response from the API endpoint 'getImageFills'.FigmaApi.FetchLibraryAnalyticsVariableActions
Retrieve library analytics variable actions data from Figma. Call this tool to obtain a breakdown of library analytics variable actions data from Figma based on a specific dimension.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | A dimension to group the returned analytics data by. Options: 'variable', 'team'. |
library_file_key | string | Required | The file key of the library for which to fetch analytics data. |
page_cursor | string | Optional | Cursor to indicate which page of data to fetch, obtained from a previous API call. |
earliest_week_start_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) representing the earliest week to include. Rounded back to the nearest week's start. Defaults to one year prior. |
end_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) for the latest week to include. Defaults to the latest computed week. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsVariableActions'.FigmaApi.FigmaGetTeamProjects
Fetch all projects within a specified Figma team. This tool retrieves a list of projects for a specified team in Figma, visible to the authenticated user.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique ID of the Figma team to list projects from. This is required to specify which team's projects to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getTeamProjects'.FigmaApi.GetDevResources
Retrieve development resources from a Figma file. Use this tool to gather development resources from a specific Figma file using the file key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_key | string | Required | The main file key for fetching development resources from a Figma file. Ensure it is not a branch key. |
target_node_ids | string | Optional | Comma separated list of node IDs to filter dev resources. If left blank, returns resources for all nodes. |
Requirements
Output
json— Response from the API endpoint 'getDevResources'.FigmaApi.GetFigmaComponentMetadata
Retrieve metadata for a Figma component by key. Use this tool to obtain detailed metadata about a specific Figma component using its key.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
component_key | string | Required | The unique identifier of the Figma component to retrieve metadata for. |
Requirements
Output
json— Response from the API endpoint 'getComponent'.FigmaApi.GetFigmaComponentSet
Retrieve metadata for a Figma component set using its key. Use this tool to obtain detailed metadata about a published component set in Figma by providing its unique key identifier.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
component_set_key | string | Required | The unique key identifier for the Figma component set to retrieve metadata. |
Requirements
Output
json— Response from the API endpoint 'getComponentSet'.FigmaApi.GetFigmaFileComments
Retrieve comments from a Figma file. Use this tool to get a list of comments left on a specific Figma file. It is useful for accessing feedback or discussions related to file elements.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
figma_file_or_branch_key | string | Required | Specify the file or branch key to retrieve comments from. Use the `GET /v1/files/:key` endpoint with `branch_data` query param for branch keys. |
return_comments_as_markdown | boolean | Optional | Set to true to return comments as markdown equivalents when applicable. |
Requirements
Output
json— Response from the API endpoint 'getComments'.FigmaApi.GetFigmaFileComponents
Retrieve published components from a Figma file library. Use this tool to obtain a list of all published components within a specific Figma file, allowing for design asset management or analysis.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_key | string | Required | Main file key to list components from. Must not be a branch key. |
Requirements
Output
json— Response from the API endpoint 'getFileComponents'.FigmaApi.GetFigmaFileNodes
Retrieve nodes and metadata from a Figma file. Use this tool to get detailed information about specific nodes in a Figma file, including metadata like name, last modified date, thumbnail URL, editor type, version, and link access permissions. Also retrieves document structure, component mappings, and styles. Useful for accessing and analyzing Figma design elements.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
node_ids_to_retrieve | string | Required | A comma-separated list of Figma node IDs to retrieve as JSON. |
figma_file_key | string | Required | The file or branch key from which to export JSON data in Figma. |
specific_version_id | string | Optional | Specify a version ID to retrieve a particular version of the Figma file. If omitted, the current version is retrieved. |
node_tree_depth | number | Optional | Positive integer indicating how deep into the node tree to traverse from the starting node. A value of 1 returns only immediate children. Leaving it unset returns all nodes. |
export_vector_data | string | Optional | Set to "paths" to include vector data in the response. |
include_plugin_data | string | Optional | Comma-separated plugin IDs and/or 'shared' to include plugin-related data in results. |
Requirements
Output
json— Response from the API endpoint 'getFileNodes'.FigmaApi.GetFigmaProjectFiles
Retrieve all files from a specific Figma project. This tool fetches a list of all files within the specified Figma project. Use it when you need to access or manage project files stored in Figma.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
project_identifier | string | Required | The unique string ID of the Figma project from which to list files. |
include_branch_metadata | boolean | Optional | Include branch metadata for each main file with a branch in the project. Set to true to receive this data, otherwise false. |
Requirements
Output
json— Response from the API endpoint 'getProjectFiles'.FigmaApi.GetFigmaWebhook
Retrieve a Figma webhook by its ID. Use this tool to obtain detailed information about a specific Figma webhook by providing its unique ID.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_id | string | Required | Unique identifier of the Figma webhook to retrieve. |
Requirements
Output
json— Response from the API endpoint 'getWebhook'.FigmaApi.GetFigmaWebhooks
Retrieve a list of webhooks from Figma. Call this tool to get a list of webhooks available in your Figma context or plan. This can be used to manage and view all the webhooks you have access to, with results provided in a paginated format.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_context | string | Optional | Specify the context for the webhooks. Accepts 'team', 'project', or 'file'. |
context_identifier | string | Optional | The ID of the context to fetch attached webhooks. Cannot be used with plan_api_id. |
plan_id_for_webhooks | string | Optional | The ID of your plan for retrieving webhooks across all accessible contexts. Cannot be used with context or context_id. |
pagination_cursor | string | Optional | Cursor for pagination when using plan_api_id. Provide next_page or prev_page from previous response to navigate pages. |
Requirements
Output
json— Response from the API endpoint 'getWebhooks'.FigmaApi.GetFileMetadata
Retrieve metadata for a specified Figma file. This tool is used to obtain metadata information from a specific Figma file by providing the file key. It can be called when users need to access details about a Figma file, such as its name, creator, and other properties.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_identifier | string | Required | File or branch key to get metadata for. Use the `branch_data` query param to get the branch key. |
Requirements
Output
json— Response from the API endpoint 'getFileMeta'.FigmaApi.GetLibraryAnalyticsComponentActions
Get analytics for library component actions. Retrieve detailed data on library component actions in Figma, broken down by the specified dimension. This tool is used to gain insights into how components in a Figma library are being utilized.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | Specify the dimension to group the analytics data by. Options are 'component' or 'team'. |
library_file_key | string | Required | The unique file key for the Figma library to retrieve analytics data from. |
data_page_cursor | string | Optional | Cursor indicating the specific page of data to fetch, obtained from a previous API call. |
earliest_start_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) for the earliest week to include. Rounded back to the start of a week. Defaults to one year prior. |
latest_inclusion_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) of the latest week to include, rounded forward to the nearest week's end. Defaults to the latest computed week. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsComponentActions'.FigmaApi.GetLibraryAnalyticsVariableUsages
Retrieve analytics on library variable usage. Fetches a breakdown of library analytics variable usage data by the specified dimension.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | Specifies the dimension ('variable' or 'file') for grouping library analytics data. |
library_file_key | string | Required | The unique key of the library to fetch analytics data from. |
page_cursor | string | Optional | A token to fetch the specific page of results, received from a previous API call. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsVariableUsages'.FigmaApi.GetLibraryStyleActions
Retrieve library style analytics actions data by dimension. Use this tool to obtain detailed actions data for styles in a Figma library, categorized by the specified dimension. Ideal for analyzing how styles are used or modified.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | Specify the dimension ('style' or 'team') to group the returned analytics data by. |
library_file_key | string | Required | The unique file key of the Figma library to retrieve analytics data for. |
pagination_cursor | string | Optional | A cursor to indicate which page of data to fetch. Obtain this from a prior API call. |
earliest_week_start_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) for the earliest week to include. Dates round back to the nearest week start. Defaults to one year prior. |
end_date | string | Optional | ISO 8601 date string (YYYY-MM-DD) for the latest week to include, rounded to the week's end. Defaults to the latest computed week if not specified. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsStyleActions'.FigmaApi.GetLibraryStyleUsageData
Retrieve style usage data from Figma library analytics. This tool returns library analytics style usage data from Figma, broken down by the requested dimension. It should be used to analyze style usage within a specific Figma library file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
group_by_dimension | string | Required | Dimension to group the returned analytics data by. Options are 'style' or 'file'. |
library_file_key | string | Required | The file key of the Figma library to fetch analytics data for. This is required to specify the source library. |
pagination_cursor | string | Optional | Cursor indicating which page of data to fetch, obtained from a previous API call. |
Requirements
Output
json— Response from the API endpoint 'getLibraryAnalyticsStyleUsages'.FigmaApi.GetPublishedComponentSets
Retrieve published component sets from a Figma file. Call this tool to get a list of published component sets within a specified Figma file library. Useful for accessing design components efficiently.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
main_file_key | string | Required | The main file key of the Figma file to list component sets from. Must not be a branch key. |
Requirements
Output
json— Response from the API endpoint 'getFileComponentSets'.FigmaApi.GetPublishedStylesFromFile
Retrieve published styles from a Figma file library. Use this tool to get a list of published styles within a specific Figma file library. Useful when you need to analyze or display the styles used in a Figma file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
main_file_key | string | Required | Main file key to list styles from. Must not be a branch key. |
Requirements
Output
json— Response from the API endpoint 'getFileStyles'.FigmaApi.GetPublishedVariables
Retrieve published variables from a Figma file. Call this tool to get a list of variables that are published from a specified Figma file. The response includes variable and collection details along with `subscribed_id`. Ideal for users needing information on published variables from a file within an Enterprise organization.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
main_file_key | string | Required | The key of the Figma file to retrieve published variables from. Only use the main file key, not a branch key. |
Requirements
Output
json— Response from the API endpoint 'getPublishedVariables'.FigmaApi.GetRecentWebhookRequests
Retrieve recent webhook requests from the last week. Use this tool to gather webhook requests sent within the last week for debugging purposes.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
webhook_subscription_id | string | Required | The ID of the webhook subscription for which to retrieve recent events. |
Requirements
Output
json— Response from the API endpoint 'getWebhookRequests'.FigmaApi.GetStyleMetadata
Retrieve Figma style metadata by key. Use this tool to get detailed metadata about a specific style in Figma using its unique key. Useful for accessing style information for design analysis or integration.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
style_key | string | Required | The unique identifier of the Figma style to retrieve metadata for. |
Requirements
Output
json— Response from the API endpoint 'getStyle'.FigmaApi.GetTeamComponents
Retrieve published components from a team's Figma library. Use this tool to get a list of components that have been published within a specified team's library in Figma.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier of the team whose components you want to retrieve. This ID is necessary to specify the source team library in Figma. |
number_of_items_per_page | number | Optional | Specify the number of components to return in one page. Defaults to 30, maximum is 1000. |
cursor_after_id | number | Optional | Cursor indicating which ID to start retrieving components after. Cannot be used with 'before'. |
cursor_before | number | Optional | Cursor to retrieve components starting before a specific id. Exclusive with 'cursor_after'. |
Requirements
Output
json— Response from the API endpoint 'getTeamComponents'.FigmaApi.GetTeamComponentSets
Fetch published component sets from a Figma team library. This tool retrieves a paginated list of component sets that have been published within a specified team library in Figma. It should be used when you need to access or explore available component sets in a particular Figma team.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier for the team from which to list component sets. |
number_of_items_per_page | number | Optional | Specify the number of items to return per page in the results. Defaults to 30. |
start_after_cursor | number | Optional | Cursor indicating the starting point for retrieving component sets, exclusive with `end_before_cursor`. This cursor is an internally tracked integer not corresponding to any IDs. |
cursor_before_id | number | Optional | Cursor ID indicating the point before which to retrieve component sets. It must be exclusive with the 'after' cursor. |
Requirements
Output
json— Response from the API endpoint 'getTeamComponentSets'.FigmaApi.GetTeamStyles
Retrieve a list of published styles from a team's library in Figma. This tool retrieves a paginated list of styles that have been published within a specified team's library in Figma. It should be called when you need access to design styles, such as colors or text styles, that a team has made available in their library.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
team_id | string | Required | The unique identifier of the team from which to retrieve published styles. |
items_per_page | number | Optional | Specify the number of styles to return per page. Defaults to 30 if not provided. |
start_after_cursor | number | Optional | Cursor to start retrieving styles after a specific ID. Cannot be used with before. Internally tracked integer. |
cursor_before_id | number | Optional | Cursor for retrieving styles before a specific ID. Use this to paginate backwards. Exclusive with after. |
Requirements
Output
json— Response from the API endpoint 'getTeamStyles'.FigmaApi.GetUserInformation
Retrieve information for the authenticated Figma user. Use this tool to obtain the profile information of the user currently authenticated in the Figma service.
Parameters
No parameters required.
Requirements
Output
json— Response from the API endpoint 'getMe'.FigmaApi.ManageFigmaVariables
Manage and organize Figma variable collections in bulk. This tool allows you to create, update, and delete variable collections, modes, and variables within Figma files for Enterprise members with Editor seats. Use it to handle variable operations in bulk, including setting mode values and managing temporary IDs. Ideal for organizing complex Figma projects efficiently. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
file_identifier | string | Optional | Specifies the Figma file or branch key to modify variables. Retrieve branch key using `GET /v1/files/:key` with `branch_data` parameter. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'postVariables'.FigmaApi.RenderFigmaImages
Fetch rendered images from Figma files by node IDs. Use this tool to render and retrieve images from a Figma file by specifying node IDs. The tool returns a mapping of node IDs to URLs of the rendered images. Note: Some entries may be null if rendering fails for certain nodes. Images expire after 30 days.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
node_ids_to_render | string | Required | A comma-separated list of node IDs for images to be rendered. |
figma_file_key | string | Required | The key for the Figma file or branch to export images from. Use with the `branch_data` query parameter to obtain branch key if needed. |
version_id | string | Optional | Specify a version ID to retrieve a particular version of a Figma file. If omitted, will use the current version. |
image_scale_factor | number | Optional | A number between 0.01 and 4, representing the image scaling factor for rendering. |
image_output_format | string | Optional | Specify the image format for the output. Options are 'jpg', 'png', 'svg', or 'pdf'. |
render_text_as_outlines | boolean | Optional | Determines if text elements are rendered as outlines in SVGs. Set `true` for visual consistency; `false` for selectable text. |
include_svg_id_attributes | boolean | Optional | Include id attributes for all SVG elements. Adds the layer name to the 'id' attribute. |
include_node_id_in_svg_elements | boolean | Optional | Set to true to include node ID attributes for all SVG elements, adding the node ID to a `data-node-id` attribute. |
svg_stroke_simplification_enabled | boolean | Optional | Set to true to simplify inside/outside strokes in SVG using stroke attributes instead of `<mask>`. |
exclude_overlapping_content | boolean | Optional | Set to true to exclude overlapping content from rendering. Set to false to include overlaps, which may increase processing time. |
use_full_dimensions_without_cropping | boolean | Optional | Export using full node dimensions, ignoring cropping and empty space. Ensures text nodes are fully visible. |
Requirements
Output
json— Response from the API endpoint 'getImages'.FigmaApi.RetrieveFigmaLocalVariables
Retrieve local and remote variables from a Figma file. Use this tool to get a list of local variables created in a Figma file and any remote variables utilized, identified by their `subscribed_id`. This tool is available to full members of Enterprise organizations. It's useful for examining mode values and understanding variable usage within a file.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
file_or_branch_key | string | Required | The key for the file or branch to retrieve variables from in Figma. If a branch, use `GET /v1/files/:key` with the `branch_data` query param to get the branch key. |
Requirements
Output
json— Response from the API endpoint 'getLocalVariables'.FigmaApi.UpdateFigmaWebhook
Update a Figma webhook by its ID. Use this tool to update the settings or parameters of an existing webhook in Figma by specifying the webhook ID. Note: Understanding the request schema is necessary to properly create the stringified JSON input object for execution. This operation also requires path parameters. Modes: - GET_REQUEST_SCHEMA: Returns the schema. Only call if you don't already have it. Do NOT call repeatedly if you already received the schema. - EXECUTE: Performs the operation with the provided request body JSON. Note: You must also provide the required path parameters when executing. If you need the schema, call with mode='get_request_schema' ONCE, then execute.
Parameters
| Parameter | Type | Req. | Description |
|---|---|---|---|
mode | string | Required | Operation mode: 'get_request_schema' returns the OpenAPI spec for the request body, 'execute' performs the actual operationget_request_schemaexecute |
webhook_id_to_update | string | Optional | Provide the ID of the Figma webhook you want to update. Required when mode is 'execute', ignored when mode is 'get_request_schema'. |
request_body | string | Optional | Stringified JSON representing the request body. Required when mode is 'execute', ignored when mode is 'get_request_schema' |
Requirements
Output
json— Response from the API endpoint 'putWebhook'.