Créer un commentaire avec l'API Figma

Publie un commentaire sur un fichier en tant qu'utilisateur connecté et le renvoie, ou une réponse quand comment_id est envoyé. Sans client_meta, le commentaire n'est pas épinglé à un endroit du canvas. Un commentaire publié ne peut pas être modifié, seulement supprimé avec Supprimer un commentaire.

Identifiant
figma_create_comment

L'appel

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

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.
messagestringOuiText of the comment.
comment_idstringNonId of the comment to reply to, from List comments. It must be a root comment, one without parent_id: replies to replies are refused.
client_metaobjectNonWhere the comment goes. Send x and y for a spot of the canvas, or node_id and node_offset to attach it to a frame; add region_width and region_height to mark an area instead of a point. A reply takes no position.

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_create_comment. 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.