Générer des images avec l'API Figma

Génère des images à partir de frames ou calques d'un fichier et renvoie, dans images, une correspondance entre chaque id de nœud et une URL temporaire de l'image, valable 30 jours. Une valeur null signifie que ce nœud n'a pas pu être rendu. Les images de plus de 32 mégapixels sont réduites. Figma place cet appel dans son niveau de limite de débit le plus bas : les fichiers d'un plan Starter et les utilisateurs avec un siège View ou Collab n'ont que 20 appels par mois.

Identifiant
figma_render_images

L'appel

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

Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.

Paramètres

Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.

ParamètreTypeObligatoireDescription
file_keystringOuiKey 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.
idsstringOuiComma-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.
formatstringNonImage format. The default is png.Valeurs : jpg, png, svg, pdf
scalenumberNonScale factor, from 0.01 to 4. The default is 1.
versionstringNonId of a version from List file versions, to render the nodes as they were then. Omit it for the current version.
contents_onlybooleanNonWhen 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_boundsbooleanNonUses 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.

Connexions possibles

Votre client connecte son compte Figma une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.

OAuth avec l'app de votre produit

Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/figma, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.

La réponse

En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.

Prête pour les agents IA

L'input de cette tool est un JSON Schema, disponible via GET /api/tools/figma_render_images. Il devient la définition de tool de votre agent sans conversion.

Autres tools Figma

Voir les 12 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.