Renderizar imagens no Figma, por uma API

Renderiza frames ou camadas de um arquivo como imagens e retorna, em images, um mapa de cada id de nó para uma URL temporária da imagem, válida por 30 dias. Valor null significa que aquele nó não pôde ser renderizado. Imagens acima de 32 megapixels são reduzidas. 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_render_images

A chamada

POST https://connect.reportei.com/api/tools/figma_render_images/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>",
    "ids": "<ids>"
  }
}

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.
idsstringSimComma-separated node ids to render, like 1:2,1:3. 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.
formatstringNãoImage format. The default is png.Valores: jpg, png, svg, pdf
scalenumberNãoScale factor, from 0.01 to 4. The default is 1.
versionstringNãoId of a version from List file versions, to render the nodes as they were then. Omit it for the current version.
contents_onlybooleanNãoWhen true, the default, content of other layers that overlaps the node is left out of the image. False includes it and takes longer.
use_absolute_boundsbooleanNãoUses the full size of the node even when it is cropped or has empty space around it, which keeps text layers from being cut. 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_render_images. 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.