Obtener archivo en Figma, con una API

Devuelve el árbol del documento de un archivo: páginas, frames y capas con sus propiedades e ids, además de los componentes y estilos que usa el archivo. El árbol de un archivo grande es enorme: pasa depth 1 para solo las páginas, o 2 para los frames de nivel superior de cada página, y luego lee un frame con Obtener nodos del archivo. Figma pone esta llamada en el nivel más bajo de límite de tasa: los archivos en un plan Starter y los usuarios con asiento View o Collab tienen solo hasta 20 llamadas al mes.

Identificador
figma_get_file

La llamada

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>"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
file_keystringSíKey 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.
depthintegerNoHow 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.
idsstringNoComma-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.
versionstringNoId of a version from List file versions, to read the file as it was then. Omit it for the current version.
branch_databooleanNoAlso returns the branches of the file with their keys, which the other tools accept as file_key. The default is false.

Conexiones posibles

Tu cliente conecta su cuenta de Figma una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/figma, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/figma_get_file. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Figma

Ver las 12 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.