Pular para o conteúdo

Figma

Figma

Figma é uma ferramenta colaborativa de design de interfaces que roda no navegador, permitindo que equipes criem, prototipem e inspecionem layouts em tempo real. Com a integração Figma no SquadOS, seus agentes podem ler arquivos de design, extrair tokens e variáveis, comentar em projetos, gerenciar webhooks e baixar imagens de nós diretamente da API do Figma.

Esta ferramenta utiliza OAuth 2.0 (OAUTH2) ou chave de API (API_KEY) para conectar.

Você vai precisar de uma das seguintes opções de autenticação:

CampoObrigatórioDescrição
Autorização OAuth 2.0Sim (modo OAuth)Autorize o acesso à sua conta Figma pela página de conexão da Composio.
api_keySim (modo API_KEY)Token de acesso pessoal gerado no painel do Figma em Settings → Security → Personal access tokens.

Consulte a documentação da Composio para os campos obrigatórios de conexão.

  1. Acesse Ferramentas no menu lateral (/admin/tools).
  2. Abra a aba Disponíveis e procure por Figma.
  3. Clique no card para abrir o modal de detalhes e em Conectar.
  4. Você é levado para a página de conexão segura hospedada pela Composio, onde autoriza o acesso (OAuth) ou informa as credenciais obtidas acima.
  5. Ao concluir, você volta para o SquadOS com a conta conectada e a ferramenta disponível para os agentes. (Detalhes do fluxo em Ferramentas da Organização.)

FIGMA_ADD_A_COMMENT_TO_A_FILE

Publica um novo comentário em um arquivo ou branch do Figma, com opção de responder a um comentário raiz existente (respostas não podem ser aninhadas); region_height e region_width em client_meta devem ser positivos ao definir uma região de comentário.

NomeTipoObrigatórioDescrição
messagestringSimTexto do comentário.
file_keystringSimChave do arquivo ou branch do Figma. Extraia da URL do arquivo: https://www.figma.com/design/FILE_KEY/... ou https://www.figma.com/file/FILE_KEY/... — é a string alfanumérica entre design/ ou file/ e a próxima barra.
comment_idstringNãoID de um comentário raiz existente ao qual responder. Respostas a respostas não são permitidas.
client_metaobjectNãoDicionário especificando a posição do comentário. Formatos válidos: 1) Coordenadas absolutas: {x, y} 2) Relativas ao nó: {node_id, node_offset: {x, y}} 3) Região absoluta: {x, y, region_height, region_width, comment_pin_corner?} 4) Região relativa ao nó: {node_id, node_offset: {x, y}, region_height, region_width, comment_pin_corner?}. Embora tecnicamente opcional, fornecer este parâmetro é fortemente recomendado.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_ADD_A_REACTION_TO_A_COMMENT

Publica uma reação emoji específica em um comentário existente de um arquivo ou branch do Figma.

NomeTipoObrigatórioDescrição
emojistringSimEmoji a usar na reação, especificado como shortcode (ex.: :heart:, :+1::skin-tone-2:).
file_keystringSimIdentificador do arquivo ou branch do Figma no qual a reação será publicada.
comment_idstringSimIdentificador único do comentário ao qual a reação será adicionada.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_CREATE_A_WEBHOOK

Cria um webhook do Figma para receber notificações POST quando eventos específicos ocorrem. Webhooks podem monitorar eventos nos escopos team, project e file. Ao ser criado, o Figma envia um evento PING inicial para verificar o endpoint (a menos que o status seja PAUSED).

NomeTipoObrigatórioDescrição
statusstring ("ACTIVE" ou "PAUSED")NãoStatus inicial do webhook. ACTIVE (padrão): operacional, recebe PING inicial na criação. PAUSED: inativo, sem eventos.
contextstring ("team", "project" ou "file")NãoEscopo do webhook. team: monitora todos os arquivos do time. project: monitora todos os arquivos do projeto. file: monitora um arquivo específico.
team_idstringNãoDEPRECIADO: use context='team' com context_id. Identificador do time Figma.
endpointstringSimURL HTTPS acessível publicamente (máx. 2048 caracteres) que recebe as requisições POST do Figma.
passcodestringSimString secreta (máx. 100 caracteres) incluída no payload do webhook para verificação de autenticidade.
context_idstringNãoID do contexto (time, projeto ou arquivo) a monitorar. Obrigatório quando context é especificado.
event_typestringSimTipo de evento que dispara o webhook: FILE_COMMENT, FILE_DELETE, FILE_UPDATE, FILE_VERSION_UPDATE ou LIBRARY_PUBLISH.
descriptionstringNãoDescrição legível do webhook (máx. 150 caracteres).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_CREATE_DEV_RESOURCES

Cria e vincula múltiplos recursos de desenvolvimento com URLs únicas a nós específicos do Figma, até 10 por nó.

NomeTipoObrigatórioDescrição
dev_resourcesarraySimLista de recursos de desenvolvimento a criar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_CREATE_MODIFY_DELETE_VARIABLES

Gerencia variáveis, coleções, modos e seus valores em um arquivo Figma via operações de criação/atualização/exclusão em lote; use IDs temporários para vincular novos itens relacionados em uma única requisição.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo ou branch do Figma a ser modificado.
variablesarrayNãoLista de operações para variáveis (CREATE, UPDATE, DELETE). Máximo de 5000 variáveis por coleção.
variableModesarrayNãoLista de operações para modos (CREATE, UPDATE, DELETE). Máximo de 40 modos por coleção.
variableModeValuesarrayNãoLista de atribuições de valores para variáveis em modos específicos.
variableCollectionsarrayNãoLista de operações para coleções de variáveis (CREATE, UPDATE, DELETE).
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DELETE_A_COMMENT

Exclui um comentário específico de um arquivo ou branch do Figma; o usuário autenticado deve ser o autor original do comentário.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo ou branch do qual o comentário será excluído.
comment_idstringSimIdentificador único do comentário a ser excluído. Somente o autor pode excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DELETE_A_REACTION

Exclui uma reação emoji específica de um comentário em um arquivo Figma; o usuário deve ter sido o autor da reação.

NomeTipoObrigatórioDescrição
emojistringSimO caractere emoji exato da reação a excluir (ex.: ❤️, 👍).
file_keystringSimChave do arquivo ou branch que contém o comentário.
comment_idstringSimIdentificador do comentário do qual a reação será removida.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DELETE_A_WEBHOOK

Exclui permanentemente um webhook existente identificado por seu webhook_id; a operação é irreversível.

NomeTipoObrigatórioDescrição
webhook_idstringSimIdentificador único do webhook a ser excluído.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DELETE_DEV_RESOURCE

Exclui um recurso de desenvolvimento (usado para vincular elementos de design do Figma a informações externas de desenvolvimento) de um arquivo Figma especificado.

NomeTipoObrigatórioDescrição
file_keystringSimIdentificador do arquivo Figma do qual excluir o recurso de dev. Deve ser a chave do arquivo principal, não de um branch.
dev_resource_idstringSimIdentificador do recurso de dev a excluir.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DESIGN_TOKENS_TO_TAILWIND

Converte tokens de design em configuração do Tailwind CSS. Fluxo em duas etapas: 1) chame FIGMA_EXTRACT_DESIGN_TOKENS com um file_key para extrair os tokens; 2) passe o objeto DesignTokens retornado para o parâmetro tokens desta ação. Gera tailwind.config.ts/js com extensões de tema e, opcionalmente, globals.css com importações de fontes.

NomeTipoObrigatórioDescrição
prefixstringNãoPrefixo para os nomes de token gerados (ex.: brand-).
tokensobjectSimObjeto de tokens de design obtido da saída de FIGMA_EXTRACT_DESIGN_TOKENS. Contém cores, tipografia, espaçamento, border-radius, sombras, total de tokens e fontes.
config_formatstringNãoFormato de saída: ts para TypeScript ou js para JavaScript.
include_font_importsbooleanNãoIncluir instruções @import para Google Fonts.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DETECT_BACKGROUND

Detecta camadas de fundo para nós selecionados em um arquivo Figma. Analisa a estrutura do documento e identifica elementos potencialmente de fundo, usando análise geométrica, ordem de z-index, propriedades visuais e convenções de nomenclatura. Retorna candidatos com pontuação de confiança (0–1) e explicações.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo extraída da URL de um arquivo Design do Figma (ex.: abc123XYZ de figma.com/design/abc123XYZ/...). Não suporta boards FigJam nem Slides.
search_depthintegerNãoQuantos níveis acima na hierarquia de nós buscar por fundos. Valores maiores encontram mais ancestrais, mas levam mais tempo. Padrão: 3.
target_node_idsarraySimLista de IDs de nós para os quais encontrar camadas de fundo. IDs de nó podem ser encontrados nas URLs do Figma após o parâmetro node-id=, ex.: 1:2 ou 123:456.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DISCOVER_FIGMA_RESOURCES

Descoberta inteligente de recursos do Figma — extrai IDs de qualquer URL do Figma. Suporta todos os formatos de URL: /file/, /design/, /board/, /proto/, /slides/. Fluxo de descoberta: team_id → projetos → arquivos → nós.

NomeTipoObrigatórioDescrição
team_idstringNãoID do time para listar todos os projetos. Obtido da URL do time: https://www.figma.com/files/team/YOUR_TEAM_ID/Team-Name. Retorna lista de projetos com IDs e nomes.
file_keystringNãoChave do arquivo para extrair todos os IDs de nó. Retorna lista hierárquica de todos os nós com IDs, nomes, tipos e caminhos.
figma_urlstringNãoURL completa do Figma para extrair file_key, node_id e team_id. Funciona com qualquer formato de URL do Figma. Esta é a forma mais fácil de obter todos os IDs necessários.
max_depthintegerNãoProfundidade máxima da árvore a percorrer ao descobrir nós. 2=páginas+frames, 3=páginas+frames+componentes, etc. Valores maiores encontram mais nós, mas levam mais tempo.
project_idstringNãoID do projeto para listar todos os arquivos. Retorna arquivos com chaves, nomes e miniaturas.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_DOWNLOAD_FIGMA_IMAGES

Baixa imagens de nós de um arquivo Figma. Renderiza nós especificados como imagens e os baixa. Suporta os formatos PNG, SVG, JPG e PDF. As URLs de imagem retornadas expiram logo após a geração — baixe-as imediatamente.

NomeTipoObrigatórioDescrição
scalenumberNãoFator de escala da imagem para exportações PNG/JPG (0,01 a 4). Padrão: 2 para qualidade retina. Ignorado para SVG/PDF.
imagesarraySimLista de requisições de download de imagem. Cada item deve ser um objeto com node_id (string, obrigatório), file_name (string, obrigatório) e opcionalmente format (padrão: png).
file_keystringSimChave do arquivo Figma extraída da URL. Identifica de qual arquivo Figma baixar as imagens.
svg_include_idbooleanNãoSomente SVG: inclui atributos id na saída SVG. Padrão: false.
svg_outline_textbooleanNãoSomente SVG: converte texto em caminhos para renderização precisa. Padrão: true.
svg_simplify_strokebooleanNãoSomente SVG: simplifica traços para saída SVG mais limpa. Padrão: true.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_EXTRACT_DESIGN_TOKENS

Extrai tokens de design de arquivos Figma combinando estilos, variáveis e valores extraídos de nós. Somente valores definidos como estilos ou variáveis do Figma são capturados. Requer o escopo file_variables:read e um plano Figma com suporte a variáveis para saída completa.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo Figma (ex.: aA1b2Cd3E4F5g6H7i8J9k0L). Extraia de URLs como figma.com/file/FILE_KEY/....
include_variablesbooleanNãoIncluir variáveis na extração. Use FIGMA_GET_LOCAL_VARIABLES para cobertura completa de tokens semânticos.
extract_from_nodesbooleanNãoExtrair tokens de propriedades de nós.
include_local_stylesbooleanNãoIncluir estilos locais na extração.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_EXTRACT_PROTOTYPE_INTERACTIONS

Extrai interações e animações de protótipos de arquivos Figma. Analisa os dados do protótipo para extrair interações do usuário (cliques, hovers, etc.), animações de transição, estados de variantes de componentes e fluxos de navegação.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo Figma extraída de uma URL como https://www.figma.com/file/ABC123xyz/MyFile.
analyze_componentsbooleanNãoExtrair estados de variantes de componentes.
include_animationsbooleanNãoIncluir dados detalhados de animação.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_ACTIVITY_LOGS

Recupera eventos do log de atividades do Figma, com filtragem por tipos de evento, intervalo de tempo e paginação.

NomeTipoObrigatórioDescrição
limitintegerNãoNúmero máximo de eventos por resposta. Padrão: 1000.
orderstring ("asc" ou "desc")NãoOrdem de classificação dos eventos por timestamp.
eventsstringNãoTipos de evento separados por vírgula a incluir. Se não especificado, retorna todos os tipos.
end_timeintegerNãoTimestamp Unix para o limite mais recente de eventos. Padrão: timestamp atual.
start_timeintegerNãoTimestamp Unix para o limite mais antigo de eventos. Padrão: um ano atrás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_A_WEBHOOK

Recupera informações detalhadas sobre um webhook específico pelo seu ID.

NomeTipoObrigatórioDescrição
webhook_idstringSimIdentificador único do webhook a recuperar.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_COMMENTS_IN_A_FILE

Recupera todos os comentários de um arquivo Figma existente, retornando detalhes como conteúdo, autor, posição e reações, com opção de formatação Markdown.

NomeTipoObrigatórioDescrição
as_mdbooleanNãoSe verdadeiro, o conteúdo dos comentários será retornado em formato Markdown. Padrão: false.
file_keystringSimIdentificador do arquivo Figma do qual recuperar os comentários.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_COMPONENT

DEPRECIADO: Use FIGMA_GET_FILE_NODES. Obtém dados de componente com simplificação automática. Retorna estrutura de componente limpa e amigável para IA.

NomeTipoObrigatórioDescrição
node_idstringSimID do nó do componente. Deve ser especificamente um ID de nó de componente.
file_keystringSimChave do arquivo que contém o componente.
response_detailstring ("minimal" ou "full")NãoNível de detalhe na resposta. minimal (padrão): simplificado para IA. full: resposta bruta da API do Figma.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_COMPONENT2

Busca metadados de um componente específico usando seu identificador único. Use para recuperar detalhes de componentes publicados de uma biblioteca de time.

NomeTipoObrigatórioDescrição
keystringSimO identificador único do componente.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_COMPONENT_SET

Recupera metadados detalhados de um conjunto de componentes Figma publicado usando sua chave única.

NomeTipoObrigatórioDescrição
keystringSimO identificador único do conjunto de componentes.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_CURRENT_USER

Recupera informações detalhadas do usuário Figma atualmente autenticado.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_DEV_RESOURCES

Recupera recursos de desenvolvimento (ex.: links Jira/GitHub) de um arquivo principal do Figma, com filtragem opcional por IDs de nó específicos.

NomeTipoObrigatórioDescrição
file_keystringSimIdentificador único do arquivo de design do Figma. Deve ser a chave do arquivo principal, não de um branch.
node_idsstringNãoString de IDs de nó separados por vírgula para filtrar recursos de dev. Exemplo: 1:2,100:54. Se omitido, retorna todos os recursos do arquivo.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_COMPONENTS

Recupera componentes publicados de um arquivo Figma, que deve ser o arquivo principal (não um branch) atuando como biblioteca.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo Figma. Deve ser um arquivo principal (não branch) que atua como biblioteca.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_COMPONENT_SETS

Recupera todos os conjuntos de componentes publicados do arquivo principal Figma especificado (a chave não deve ser de um branch).

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo Figma. Deve ser a chave do arquivo principal, não de um branch.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_JSON

Obtém dados de um arquivo Design do Figma com simplificação automática. Suporta apenas arquivos Design (figma.com/design/{file_key}). Boards FigJam e Slides não são suportados. Transforma o JSON do Figma em formato limpo e amigável para IA, com redução de tamanho de mais de 70%.

NomeTipoObrigatórioDescrição
idsstringNãoIDs de nó separados por vírgula para buscar nós específicos. Exemplo: 1:2,1:3. IDs de nó nas URLs usam hífens (ex.: 1-2); converta para dois-pontos (ex.: 1:2) antes de passar.
depthintegerNãoProfundidade de travessia da árvore (ex.: 2 para páginas e filhos de nível superior). Omitir em arquivos grandes pode causar respostas muito grandes ou timeouts.
versionstringNãoID de versão específica; versão atual se omitido.
file_keystringSimChave do arquivo extraída de uma URL Design do Figma. Não suporta boards FigJam nem Slides.
geometrystringNãoDefina como paths para incluir dados vetoriais.
branch_databooleanNãoIncluir metadados de branch.
plugin_datastringNãoIDs de plugin separados por vírgula para incluir dados de plugin.
response_detailstring ("minimal" ou "full")NãoNível de detalhe: minimal (padrão) simplifica para IA; full retorna a resposta bruta da API.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_METADATA

Obtém metadados do arquivo Figma, incluindo nome, criador, detalhes da última modificação, miniatura e informações de acesso. Use quando precisar de uma visão geral rápida do arquivo sem a árvore completa do documento.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo para obter metadados. Pode ser chave de arquivo ou de branch.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_NODES

Busca JSON de IDs de nó específicos de um arquivo Figma para evitar limites de payload do arquivo completo. Use quando já conhecer os IDs dos nós alvo.

NomeTipoObrigatórioDescrição
idsstringSimIDs de nó a recuperar. Forneça como string separada por vírgulas (ex.: 1:5,1:6) ou lista de strings.
depthintegerNãoProfundidade de traversal na subárvore de cada nó solicitado. Use depth=1 para descoberta rápida de estrutura.
versionstringNãoID de versão específica. Omita para a versão atual.
file_keystringSimChave do arquivo ou branch do Figma extraída da URL.
geometrystringNãoDefina como paths para incluir dados de caminho vetorial na resposta.
plugin_datastringNãoIDs de plugin separados por vírgulas ou shared para incluir dados de plugin.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILES_IN_A_PROJECT

Busca uma lista de arquivos em um projeto do Figma, incluindo opcionalmente metadados de branches.

NomeTipoObrigatórioDescrição
project_idstringSimIdentificador do projeto Figma, encontrado normalmente na URL.
branch_databooleanNãoSe verdadeiro, inclui metadados de branches dos arquivos principais.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_FILE_STYLES

Recupera uma lista de estilos publicados (como cores, atributos de texto, efeitos e grids de layout) de um arquivo principal do Figma (não branch). Retorna apenas estilos PUBLICADOS em bibliotecas de time.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo principal do Figma (não branch) do qual recuperar estilos publicados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_IMAGE_FILLS

Recupera URLs de download temporárias (validade de 14 dias) para todos os preenchimentos de imagem em um arquivo Figma.

NomeTipoObrigatórioDescrição
file_keystringSimIdentificador único do arquivo Figma. String alfanumérica de 22 caracteres extraída da URL do arquivo.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de ação de componente da biblioteca (analytics)

Seção intitulada “Obter dados de ação de componente da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_COMPONENT_ACTION_DATA

Recupera analytics de inserção e desvinculação de componentes de uma biblioteca Figma especificada, agrupáveis por component ou team e filtráveis por intervalo de datas (AAAA-MM-DD).

NomeTipoObrigatórioDescrição
cursorstringNãoCursor opaco para paginação; omita na primeira página.
end_datestringNãoData final (AAAA-MM-DD) para os analytics. Padrão: semana mais recente.
file_keystringSimIdentificador da biblioteca Figma. Deve ser uma biblioteca publicada de uma organização Enterprise.
group_bystring ("component" ou "team")SimDimensão de agrupamento dos analytics.
start_datestringNãoData inicial (AAAA-MM-DD) para os analytics. Padrão: um ano atrás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de uso de componente da biblioteca (analytics)

Seção intitulada “Obter dados de uso de componente da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_COMPONENT_USAGE_DATA

Recupera analytics de uso de componentes de uma biblioteca Figma, agrupáveis por component ou file.

NomeTipoObrigatórioDescrição
cursorstringNãoString opaca para paginação da próxima página, obtida de uma resposta anterior.
file_keystringSimIdentificador da biblioteca Figma. Deve ser uma biblioteca publicada de uma organização Enterprise.
group_bystring ("component" ou "file")SimDimensão de agrupamento: component para stats por componente; file para ver quais arquivos usam a biblioteca.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de ação de estilo da biblioteca (analytics)

Seção intitulada “Obter dados de ação de estilo da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_STYLE_ACTION_DATA

Recupera analytics de uso de estilos (inserções, desvinculações) de uma biblioteca Figma, agrupáveis por style ou team; certifique-se de que end_date não seja anterior a start_date.

NomeTipoObrigatórioDescrição
cursorstringNãoCursor opaco para paginação; omita na primeira página.
end_datestringNãoData final (AAAA-MM-DD) para os analytics. Padrão: semana mais recente.
file_keystringSimIdentificador da biblioteca Figma. Deve ser uma biblioteca publicada de uma organização Enterprise.
group_bystring ("style" ou "team")SimDimensão de agrupamento: style para métricas por estilo; team para métricas por time.
start_datestringNãoData inicial (AAAA-MM-DD) para os analytics. Padrão: um ano atrás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de uso de estilo da biblioteca (analytics)

Seção intitulada “Obter dados de uso de estilo da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_STYLE_USAGE_DATA

Recupera analytics de uso de estilos de uma biblioteca Figma publicada. Retorna dados sobre como estilos (cores, estilos de texto, efeitos, grids) da biblioteca são usados na organização. Requer plano Enterprise e escopo library_analytics:read.

NomeTipoObrigatórioDescrição
cursorstringNãoCursor de paginação de uma resposta anterior. Omita para a primeira página.
file_keystringSimChave única do arquivo de biblioteca Figma publicada. Disponível apenas em planos Enterprise.
group_bystring ("file" ou "style")SimAgrupamento: style retorna stats de uso por estilo; file retorna stats por arquivo que usa a biblioteca.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de ação de variável da biblioteca (analytics)

Seção intitulada “Obter dados de ação de variável da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_VARIABLE_ACTION_DATA

Recupera analytics semanais paginados sobre inserções e desvinculações de variáveis de uma biblioteca Figma, agrupáveis por variable ou team, com filtragem opcional por intervalo de datas. Requer plano Enterprise e escopo library_analytics:read.

NomeTipoObrigatórioDescrição
cursorstringNãoCursor opaco para paginação; omita na primeira página.
end_datestringNãoData final (AAAA-MM-DD) para o intervalo de analytics. Padrão: semana mais recente.
file_keystringSimIdentificador único da biblioteca Figma para recuperar os analytics de variáveis.
group_bystring ("team" ou "variable")SimDimensão de agrupamento dos dados.
start_datestringNãoData inicial (AAAA-MM-DD) para o intervalo de analytics. Padrão: um ano atrás.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

Obter dados de uso de variável da biblioteca (analytics)

Seção intitulada “Obter dados de uso de variável da biblioteca (analytics)”

FIGMA_GET_LIBRARY_ANALYTICS_VARIABLE_USAGE_DATA

Recupera analytics paginados de uso de variáveis de uma biblioteca Figma especificada, agrupados por file ou variable, para bibliotecas com analytics habilitados.

NomeTipoObrigatórioDescrição
cursorstringNãoCursor opaco para paginação, obtido do campo cursor de uma resposta anterior. Omita na primeira página.
file_keystringSimChave da biblioteca Figma para recuperar analytics de uso de variáveis. Deve ser de uma organização Enterprise.
group_bystring ("file" ou "variable")SimDimensão de agrupamento dos dados.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_LOCAL_VARIABLES

Recupera todas as variáveis locais/remotas de um arquivo ou branch do Figma; essencial para obter valores específicos de modo que /v1/files/{file_key}/variables/published omite.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo ou branch do Figma.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_PAYMENTS

Recupera informações de pagamento de um usuário para um plugin, widget ou arquivo da Comunidade do Figma; a identidade autenticada deve ser proprietária do recurso.

NomeTipoObrigatórioDescrição
user_idintegerNãoID do usuário cujas informações de pagamento são buscadas. Obtenha via OAuth2 com a API REST do Figma. Obrigatório se plugin_payment_token não for fornecido.
plugin_idintegerNãoID do plugin. Se user_id for fornecido, especifique exatamente um de community_file_id, plugin_id ou widget_id.
widget_idintegerNãoID do widget. Se user_id for fornecido, especifique exatamente um dos três campos de recurso.
community_file_idintegerNãoID do arquivo da Comunidade. Se user_id for fornecido, especifique exatamente um dos três campos de recurso.
plugin_payment_tokenstringNãoToken de autenticação de curta duração de getPluginPaymentTokenAsync (API de Pagamentos do Plugin Figma). Se fornecido, user_id e IDs de recurso geralmente não são necessários.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_PROJECTS_IN_A_TEAM

Recupera projetos dentro de um time Figma especificado que são visíveis ao usuário autenticado.

NomeTipoObrigatórioDescrição
team_idstringSimIdentificador do time Figma. Para encontrar o team_id, navegue até a página do time no Figma — ele estará na URL no formato https://www.figma.com/files/team/YOUR_TEAM_ID/Your_Team_Name.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_PUBLISHED_VARIABLES

Recupera variáveis publicadas de um arquivo Figma; esta API está disponível apenas para membros completos de organizações Enterprise.

NomeTipoObrigatórioDescrição
file_keystringSimChave do arquivo Figma do qual recuperar as variáveis publicadas. Deve ser a chave do arquivo principal, não de um branch.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_REACTIONS_FOR_A_COMMENT

Recupera reações de um comentário específico em um arquivo Figma.

NomeTipoObrigatórioDescrição
cursorstringNãoCursor de paginação de uma resposta anterior. Omita na primeira página.
file_keystringSimChave do arquivo ou branch do Figma.
comment_idstringSimIdentificador do comentário.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_SCIM_SERVICE_PROVIDER_CONFIG

Obtém a configuração do provedor de serviço SCIM do Figma. Retorna detalhes de configuração incluindo quais operações SCIM são suportadas (patch, bulk, filter, etc.), esquemas de autenticação e capacidades do serviço.

NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_STYLE

Recupera metadados detalhados de um estilo específico no Figma usando sua chave de estilo única.

NomeTipoObrigatórioDescrição
keystringSimIdentificador único (chave) do estilo a recuperar. As chaves de estilo são strings hexadecimais de 40 caracteres obtidas dos endpoints de estilos do arquivo ou do time.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_TEAM_COMPONENTS

Recupera componentes publicados na biblioteca de um time Figma específico; se o time não tiver componentes publicados, retorna lista vazia.

NomeTipoObrigatórioDescrição
afterintegerNãoCursor opaco indicando o ponto após o qual recuperar componentes. Mutuamente exclusivo com before.
beforeintegerNãoCursor opaco indicando o ponto antes do qual recuperar componentes. Mutuamente exclusivo com after.
team_idstringSimIdentificador único do time Figma. O team_id está na URL da página do time: https://www.figma.com/files/team/YOUR_TEAM_ID/Team-Name.
page_sizeintegerNãoNúmero de componentes a retornar por página. Máximo: 1000.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_TEAM_COMPONENT_SETS

Recupera uma lista paginada de conjuntos de componentes publicados (coleções de elementos de UI reutilizáveis) da biblioteca de um time Figma especificado.

NomeTipoObrigatórioDescrição
afterintegerNãoCursor de paginação indicando o ponto após o qual recuperar os conjuntos. Mutuamente exclusivo com before.
beforeintegerNãoCursor de paginação indicando o ponto antes do qual recuperar os conjuntos. Mutuamente exclusivo com after.
team_idstringSimIdentificador único do time Figma. O team_id está na URL da página do time.
page_sizeintegerNãoNúmero de conjuntos de componentes a retornar por página.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_TEAM_STYLES

Recupera uma lista paginada de estilos publicados (cores de preenchimento, estilos de texto, efeitos, grids) da biblioteca de um time Figma especificado.

NomeTipoObrigatórioDescrição
afterintegerNãoCursor inteiro para recuperar estilos após este ponto. Mutuamente exclusivo com before.
beforeintegerNãoCursor inteiro para recuperar estilos antes deste ponto. Mutuamente exclusivo com after.
team_idstringSimIdentificador do time Figma. O team_id está na URL da página do time.
page_sizeintegerNãoNúmero de estilos a retornar por página. Máximo: 100.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_TEAM_WEBHOOKS

Recupera todos os webhooks registrados para um contexto Figma especificado (time, projeto ou arquivo). Usa o endpoint da API Webhooks V2 do Figma. O team_id, project_id e file_key não podem ser descobertos programaticamente — extraia-os de URLs do Figma.

NomeTipoObrigatórioDescrição
contextstring ("team", "project" ou "file")NãoTipo de contexto para consultar webhooks. Padrão: team.
context_idstringSimID do contexto. Para team: é o team_id. Para project: é o project_id. Para file: é o file_key.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_VERSIONS_OF_A_FILE

Recupera o histórico de versões de um arquivo ou branch do Figma especificado por seu file_key.

NomeTipoObrigatórioDescrição
afterintegerNãoID de versão para paginação; recupera versões criadas estritamente após este ID.
beforeintegerNãoID de versão para paginação; recupera versões criadas estritamente antes deste ID.
file_keystringSimChave do arquivo ou branch do qual recuperar o histórico de versões. O usuário autenticado deve ter acesso ao arquivo.
page_sizeintegerNãoNúmero de itens de versão por página. Padrão: 30.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_GET_WEBHOOK_REQUESTS

Recupera o histórico de requisições de um webhook específico do Figma; os dados estão disponíveis para requisições enviadas nos últimos sete dias.

NomeTipoObrigatórioDescrição
webhook_idstringSimIdentificador único da assinatura de webhook do Figma para a qual recuperar as requisições anteriores.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_RENDER_IMAGES_OF_FILE_NODES

Renderiza nós do Figma como imagens (PNG, JPG, SVG, PDF). Retorna um mapa de IDs de nó para URLs temporárias de imagem (válidas por 30 dias). Imagens são limitadas a 32 megapixels; requisições maiores são automaticamente redimensionadas.

NomeTipoObrigatórioDescrição
idsstringSimLista de IDs de nó separados por vírgula a renderizar. Encontrados nas URLs do Figma após node-id= ou na resposta de FIGMA_GET_FILE_JSON. Exemplo: 1:2,1:3,1:4.
scalenumberNãoFator de escala entre 0,01 e 4,0. Aplica-se apenas a PNG/JPG; ignorado para SVG/PDF.
formatstring ("jpg", "pdf", "png" ou "svg")NãoFormato de saída da imagem.
versionstringNãoID de versão específica do arquivo a renderizar. Omita para usar a versão atual.
file_keystringSimChave do arquivo ou branch do Figma.
contents_onlybooleanNãoSe verdadeiro, exclui conteúdo que ultrapassa os limites do nó.
svg_include_idbooleanNão(Somente SVG) Inclui atributos id nos elementos SVG.
svg_outline_textbooleanNão(Somente SVG) Renderiza texto como caminhos vetoriais para fidelidade visual exata.
svg_include_node_idbooleanNão(Somente SVG) Adiciona atributo data-node-id com o ID do nó Figma.
svg_simplify_strokebooleanNão(Somente SVG) Simplifica traços usando atributo stroke em vez de mask.
use_absolute_boundsbooleanNãoSe verdadeiro, usa as dimensões completas do nó ignorando corte/espaço vazio.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_UPDATE_A_WEBHOOK

Atualiza um webhook Figma existente identificado por webhook_id, permitindo modificar seu tipo de evento, endpoint, passcode, status ou descrição.

NomeTipoObrigatórioDescrição
statusstring ("ACTIVE" ou "PAUSED")NãoStatus operacional: ACTIVE para receber eventos; PAUSED para pausar temporariamente.
endpointstringNãoURL do endpoint HTTPS para receber as requisições POST dos eventos do webhook. Máx. 2048 caracteres.
passcodestringNãoString secreta para verificação de autenticidade do webhook. Máx. 100 caracteres.
event_typestringNãoTipo de evento que dispara o webhook: FILE_COMMENT, FILE_DELETE, FILE_UPDATE, FILE_VERSION_UPDATE, LIBRARY_PUBLISH ou PING.
webhook_idstringSimIdentificador único do webhook existente a atualizar.
descriptionstringNãoDescrição legível do webhook. Máx. 140 caracteres. Passe string vazia para remover.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.

FIGMA_UPDATE_DEV_RESOURCES

Atualiza o nome e/ou URL de um ou mais recursos de dev existentes no Figma, cada um identificado por seu id único.

NomeTipoObrigatórioDescrição
dev_resourcesarraySimLista de recursos de dev a atualizar. Cada item deve incluir seu id e pode fornecer um novo name e/ou url.
NomeTipoObrigatórioDescrição
datastringSimDados retornados pela execução da ação.
errorstringNãoMensagem de erro caso a execução tenha falhado.
successfulbooleanSimIndica se a ação foi executada com sucesso.