Figma API - Design Asset Extraction & Export

API Integration

This actor connects to an external API service. You'll need valid API credentials from the service provider.

---

API Integration

This actor connects to an external API service. You'll need valid API credentials from the service provider.

---

Extract designs, components, styles, and images from Figma files. Export frames and nodes as PNG, JPG, SVG, or PDF. Perfect for design system documentation and asset automation.

Features

File Operations

• Get File - Retrieve complete file JSON with all layers and properties
• Get File Nodes - Extract specific nodes by ID
• Get File Metadata - Get file info without full content
• Get File Versions - Access version history

Asset Export

• Export Images - Render nodes as PNG, JPG, SVG, or PDF
• Get Image Fills - Download all images used in the file
• Batch Export - Export multiple nodes in one run

Components & Styles

• Get Team/File Components - List published components
• Get Component - Fetch component details by key
• Get Team/File Styles - List color, text, and effect styles
• Get Style - Fetch style details by key
• Get Variables - Access design tokens and variables

Collaboration

• Get Comments - Retrieve file comments
• Post Comment - Add comments to files

Organization

• Get Team Projects - List projects in a team
• Get Project Files - List files in a project
• Get User - Current user info

Quick Start

{
  "input": "your input here"
}

Demo Mode

Set demoMode: true to test with sample data (no charges). When you're ready for real results, set demoMode: false or omit it.

{
  "demoMode": true,
  ...
}

Input Parameters

Parameter	Type	Required	Description
task	string	Yes	Operation to perform (see tasks below)
accessToken	string	Yes*	Figma personal access token (*not needed for demoMode)
fileKey	string	No	File key from Figma URL
nodeIds	string	No	Comma-separated node IDs
teamId	string	No	Team ID for team operations
projectId	string	No	Project ID
componentKey	string	No	Component key
styleKey	string	No	Style key
exportFormat	string	No	Export format: png, jpg, svg, pdf
exportScale	number	No	Export scale (0.01-4)
depth	integer	No	Document traversal depth (1-4)
batchNodes	array	No	Nodes for batch export
webhookUrl	string	No	URL for webhook delivery
demoMode	boolean	No	Run with sample data (default: true)

Output Format

Results are saved to the default dataset:

Export Result

{
  "task": "export_images",
  "success": true,
  "images": {
    "1:2": "https://figma-alpha-api.s3.us-west-2.amazonaws.com/images/...",
    "1:3": "https://figma-alpha-api.s3.us-west-2.amazonaws.com/images/..."
  },
  "format": "png",
  "scale": 2,
  "fileKey": "abc123xyz"
}

Components Result

{
  "task": "get_file_components",
  "success": true,
  "components": [
    {
      "key": "comp_abc123",
      "name": "Button/Primary",
      "description": "Primary action button",
      "thumbnailUrl": "https://..."
    }
  ],
  "total": 45,
  "fileKey": "abc123xyz"
}

Pricing

This actor uses pay-per-event billing: Pay-per-result pricing:

Operation	Cost
Get file/nodes/metadata	$0.02
Get file versions	$0.01
Export images (per node)	$0.03
Get image fills	$0.02
Get/post comments	$0.01
Get team projects/files	$0.01
Get components/styles	$0.02
Get variables	$0.02
Batch export (per node)	$0.03

Use Cases

Design System Documentation

• Auto-generate component libraries
• Extract color palettes and typography
• Document design tokens/variables

Asset Pipelines

• Export icons and assets at multiple scales
• Generate app store screenshots
• Create marketing asset libraries

Design-to-Code

• Extract design specifications
• Generate style guides
• Sync design tokens to code

Design QA

• Track design changes via versions
• Monitor comments and feedback
• Audit component usage

Automation Workflows

• Trigger exports when files change
• Sync assets to CDN or storage
• Generate design reports

---

Common Problems & Solutions

"Invalid API key" error

Cause: Your API key is wrong, expired, or doesn't have the right permissions. Fix: Double-check your API key. Make sure you copied it exactly without extra spaces.

"Rate limit exceeded" error

Cause: You've hit the API's rate limits. Fix: Wait a few minutes, then try again. Consider reducing the number of concurrent requests.

Empty or incomplete results

Cause: The target may have anti-scraping protection or the data doesn't exist. Fix:

• Check if the URL/search query is correct
• Try with different parameters
• Some sites may block automated access

Demo data showing instead of real results

Cause: demoMode is still set to true. Fix: Set demoMode: false and provide your API key(s).

---

Built by John Rippy | Actor Arsenal