Back to Details

figma-api

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Figma API

Figma API

This is the OpenAPI specification for the Figma REST API.
这是Figma REST API的OpenAPI规范。

How to Use This Skill

如何使用本技能

This API documentation is split into multiple files for on-demand loading.
Directory structure:
references/
├── resources/      # 14 resource index files
├── operations/     # 46 operation detail files
└── schemas/        # 105 schema groups, 223 schema files
Navigation flow:
  1. Find the resource you need in the list below
  2. Read 
    references/resources/<resource>.md
    to see available operations
  3. Read 
    references/operations/<operation>.md
    for full details
  4. If an operation references a schema, read 
    references/schemas/<prefix>/<schema>.md
本API文档拆分为多个文件，支持按需加载。
目录结构：
references/
├── resources/      # 14个资源索引文件
├── operations/     # 46个操作详情文件
└── schemas/        # 105个模式组，223个模式文件
导航流程：
  1. 在下方列表中找到你需要的资源
  2. 阅读
    references/resources/<resource>.md
    查看可用操作
  3. 阅读
    references/operations/<operation>.md
    获取完整详情
  4. 如果某个操作引用了模式，请阅读
    references/schemas/<prefix>/<schema>.md

Base URL

基础URL

  • https://api.figma.com
  • https://api.figma.com

Authentication

认证

Supported methods: PersonalAccessToken, OAuth2, OrgOAuth2. See 
references/authentication.md
for details.
支持的方式：PersonalAccessToken、OAuth2、OrgOAuth2。详情请查看
references/authentication.md
。

Resources

资源

  • Webhooks → 
    references/resources/Webhooks.md
    (7 ops) - Interact with team webhooks as a team admin.
  • Files → 
    references/resources/Files.md
    (6 ops) - Get file JSON, images, and other file-related cont
  • Library Analytics → 
    references/resources/Library-Analytics.md
    (6 ops) - Get analytics data for your published libraries.
  • Dev Resources → 
    references/resources/Dev-Resources.md
    (4 ops) - Interact with dev resources in Figma Dev Mode.
  • Comments → 
    references/resources/Comments.md
    (3 ops) - Interact with file comments.
  • Comment Reactions → 
    references/resources/Comment-Reactions.md
    (3 ops) - Interact with reactions to file comments.
  • Components → 
    references/resources/Components.md
    (3 ops) - Get information about published components.
  • Component Sets → 
    references/resources/Component-Sets.md
    (3 ops) - Get information about published component sets.
  • Styles → 
    references/resources/Styles.md
    (3 ops) - Get information about published styles.
  • Variables → 
    references/resources/Variables.md
    (3 ops) - Interact with variables in an Enterprise organizat
  • Projects → 
    references/resources/Projects.md
    (2 ops) - Get information about projects and files in teams.
  • Users → 
    references/resources/Users.md
    (1 ops) - Get information about the currently authenticated
  • Activity Logs → 
    references/resources/Activity-Logs.md
    (1 ops) - Get activity logs as an organization admin.
  • Payments → 
    references/resources/Payments.md
    (1 ops) - Get purchase information for your Community resour
  • Webhooks → 
    references/resources/Webhooks.md
    （7个操作）- 以团队管理员身份与团队Webhooks交互。
  • Files → 
    references/resources/Files.md
    （6个操作）- 获取文件JSON、图片及其他文件相关内容
  • Library Analytics → 
    references/resources/Library-Analytics.md
    （6个操作）- 获取已发布资源库的分析数据。
  • Dev Resources → 
    references/resources/Dev-Resources.md
    （4个操作）- 在Figma开发模式中与开发资源交互。
  • Comments → 
    references/resources/Comments.md
    （3个操作）- 与文件评论交互。
  • Comment Reactions → 
    references/resources/Comment-Reactions.md
    （3个操作）- 与文件评论的反应交互。
  • Components → 
    references/resources/Components.md
    （3个操作）- 获取已发布组件的信息。
  • Component Sets → 
    references/resources/Component-Sets.md
    （3个操作）- 获取已发布组件集的信息。
  • Styles → 
    references/resources/Styles.md
    （3个操作）- 获取已发布样式的信息。
  • Variables → 
    references/resources/Variables.md
    （3个操作）- 与企业组织中的变量交互
  • Projects → 
    references/resources/Projects.md
    （2个操作）- 获取团队中的项目和文件信息。
  • Users → 
    references/resources/Users.md
    （1个操作）- 获取当前已认证用户的信息
  • Activity Logs → 
    references/resources/Activity-Logs.md
    （1个操作）- 以组织管理员身份获取活动日志。
  • Payments → 
    references/resources/Payments.md
    （1个操作）- 获取你的社区资源的购买信息