{ "openapi": "3.0.1", "info": { "title": "Figma API - Design Asset Extraction & Export", "description": "Extract designs, components, styles, and images from Figma files using the official REST API. Export frames and nodes as PNG, JPG, SVG, or PDF. Perfect for design system documentation, asset pipelines, and design-to-code workflows.", "version": "1.0", "x-build-id": "v6Zvt0IhmR6Tvu04Z" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alizarin_refrigerator-owner~figma-api---design-asset-extraction-export/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alizarin_refrigerator-owner-figma-api---design-asset-extraction-export", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/alizarin_refrigerator-owner~figma-api---design-asset-extraction-export/runs": { "post": { "operationId": "runs-sync-alizarin_refrigerator-owner-figma-api---design-asset-extraction-export", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/alizarin_refrigerator-owner~figma-api---design-asset-extraction-export/run-sync": { "post": { "operationId": "run-sync-alizarin_refrigerator-owner-figma-api---design-asset-extraction-export", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "task" ], "properties": { "task": { "title": "Task", "enum": [ "get_file", "get_file_nodes", "get_file_metadata", "get_file_versions", "export_images", "get_image_fills", "get_comments", "post_comment", "get_team_projects", "get_project_files", "get_team_components", "get_file_components", "get_component", "get_team_styles", "get_file_styles", "get_style", "get_variables", "get_user", "batch_export" ], "type": "string", "description": "Operation to perform", "default": "get_file" }, "accessToken": { "title": "Access Token", "type": "string", "description": "Figma personal access token or OAuth token" }, "fileKey": { "title": "File Key", "type": "string", "description": "Figma file key (from URL: figma.com/file/FILE_KEY/...)" }, "nodeIds": { "title": "Node IDs", "type": "string", "description": "Comma-separated node IDs for specific operations" }, "teamId": { "title": "Team ID", "type": "string", "description": "Figma team ID for team-level operations" }, "projectId": { "title": "Project ID", "type": "string", "description": "Figma project ID" }, "componentKey": { "title": "Component Key", "type": "string", "description": "Component key for get_component" }, "styleKey": { "title": "Style Key", "type": "string", "description": "Style key for get_style" }, "exportFormat": { "title": "Export Format", "enum": [ "png", "jpg", "svg", "pdf" ], "type": "string", "description": "Image export format", "default": "png" }, "exportScale": { "title": "Export Scale", "minimum": 0.01, "maximum": 4, "type": "number", "description": "Export scale (0.01 to 4)", "default": 1 }, "commentMessage": { "title": "Comment Message", "type": "string", "description": "Message text for posting comments" }, "commentX": { "title": "Comment X Position", "type": "number", "description": "X coordinate for comment placement" }, "commentY": { "title": "Comment Y Position", "type": "number", "description": "Y coordinate for comment placement" }, "depth": { "title": "Traversal Depth", "minimum": 1, "maximum": 4, "type": "integer", "description": "Depth to traverse the document tree (1-4)" }, "version": { "title": "File Version", "type": "string", "description": "Specific version ID to fetch" }, "maxResults": { "title": "Max Results", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of results to return", "default": 20 }, "batchNodes": { "title": "Batch Export Nodes", "type": "array", "description": "Array of node configurations for batch export: [{nodeId, format, scale}]", "default": [] }, "webhookUrl": { "title": "Webhook URL", "type": "string", "description": "URL to send results to (Zapier, Make, n8n, etc.)" }, "demoMode": { "title": "Demo Mode", "type": "boolean", "description": "Run with sample data (no access token required)", "default": true } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }