Obter arquivo no Figma, por uma API

Retorna a árvore do documento de um arquivo: páginas, frames e camadas com suas propriedades e ids, além dos componentes e estilos que o arquivo usa. A árvore de um arquivo grande é enorme: passe depth 1 para só as páginas, ou 2 para os frames de nível superior de cada página, e depois leia um frame com Obter nós do arquivo. O Figma coloca esta chamada no menor nível de limite de taxa: arquivos em um plano Starter e usuários com assento View ou Collab têm só até 20 chamadas por mês.

Identificador
figma_get_file

A chamada

POST https://connect.reportei.com/api/tools/figma_get_file/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "file_key": "<file_key>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
file_keystringSimKey of the file: the part after /design/, /file/ or /board/ in the URL of the file in Figma. The key of a branch also works.
depthintegerNãoHow deep to go into the tree, counted from the document: 1 returns the pages, 2 the pages and their top-level frames. Omit it to return every layer.
idsstringNãoComma-separated node ids, like 1:2,1:3, to return only those nodes, their children and the path to them. A node id is the node-id of a Figma link with the hyphen changed to a colon (node-id=1-2 is 1:2), or an id returned by Get file.
versionstringNãoId of a version from List file versions, to read the file as it was then. Omit it for the current version.
branch_databooleanNãoAlso returns the branches of the file with their keys, which the other tools accept as file_key. The default is false.

Conexões possíveis

O seu cliente conecta a conta do Figma uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/figma, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/figma_get_file. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Figma

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.