Learn how to integrate with Infa programmatically using our REST API for design system data access.
The Infa External API provides access to your design system data, allowing you to integrate Infa with third-party tools and services. This feature is available on all paid Infa plans (Pro, Team and Enterprise).
Copy link
Overview
We at Infa designed this API for external integrations like Figma plugins, Coda packs, and custom applications. The API provides read-only access to your design system components, boards, and related data.
Base URL: https://api.infa.ai/rest/v1/rpc/
Copy link
Authentication
Copy link
API Key Requirements
The Infa External API requires two headers for authentication:
x-api-key - Your personal API key (generate from your profile page)
Click the token's copy button and store the key securely. The table shows only the first four characters (abcd****); that preview is not the key
Note
We are working on write permissions as well. The generated API key has limited access to specific API endpoints. If you would like additional integrations or want to test more features with us, please reach out to us.
Copy link
Available Endpoints
The Infa API provides the following endpoints:
User Information: Get current user details
Boards: List all accessible boards
Main Components: Retrieve design system components
Component Views: Get component screenshots and code
Get Components for Storybook (get_storybook_main_components)
What the Storybook addon reads: the components you name, each with its views, labels, external links and the screens of its board. The addon's npx infa-usage-fetch command calls it for you.
Endpoint: POST /rest/v1/rpc/get_storybook_main_components
Infa External API
The Infa External API provides access to your design system data, allowing you to integrate Infa with third-party tools and services. This feature is available on all paid Infa plans (Pro, Team and Enterprise).
We at Infa designed this API for external integrations like Figma plugins, Coda packs, and custom applications. The API provides read-only access to your design system components, boards, and related data.
Base URL:
https://api.infa.ai/rest/v1/rpc/The Infa External API requires two headers for authentication:
x-api-key- Your personal API key (generate from your profile page)apikey- Fixed value for all requestsImportant Notes:
your_personal_api_key_herewith your actual API key from your profileapikeyvalue exactly as shown above (same for everyone)abcd****); that preview is not the keyThe Infa API provides the following endpoints:
me)Retrieve information about the authenticated user.
Endpoint:
GET /rest/v1/rpc/meResponse:
Example Usage:
get_boards)Retrieve all boards accessible to the authenticated user.
Endpoint:
GET /rest/v1/rpc/get_boardsResponse:
Example Usage:
get_main_components)Retrieve main components, optionally filtered by board.
Endpoint:
GET /rest/v1/rpc/get_main_componentsParameters:
p_board_id(optional): Filter components by specific board IDResponse:
Example Usage:
get_component_views)Retrieve component views (screenshots and code examples), optionally filtered by board.
Endpoint:
GET /rest/v1/rpc/get_component_viewsParameters:
p_board_id(optional): Filter views by specific board IDResponse:
get_storybook_main_components)What the Storybook addon reads: the components you name, each with its views, labels, external links and the screens of its board. The addon's
npx infa-usage-fetchcommand calls it for you.Endpoint:
POST /rest/v1/rpc/get_storybook_main_componentsBody:
{ "p_mc_component_ids": ["mc_abc12345"] }Components on boards the key's account does not own are left out of the answer.
get_external_links)Retrieve external links associated with components.
Endpoint:
GET /rest/v1/rpc/get_external_linksResponse:
get_screens)Retrieve page structure data, optionally filtered by board.
Endpoint:
GET /rest/v1/rpc/get_screensParameters:
p_board_id(optional): Filter screens by specific board IDResponse:
get_screen_reports)Retrieve page coverage reports with component breakdown and metrics, optionally filtered by board or page.
Endpoint:
GET /rest/v1/rpc/get_screen_reportsParameters:
p_board_id(optional): Filter reports by specific board IDp_screen_id(optional): Filter reports by specific page IDResponse:
Example Usage:
Field Descriptions:
dom_coverage_ratio: Ratio of DOM elements covered by components (0-1)real_estate_ratio: Legacy field for visual coveragevisual_coverage_percentage: Percentage of page area covered by componentstotal_component_count: Total number of component instances detectedtotal_dom_elements: Total DOM elements on the pagedom_component_coverage: Number of DOM elements within componentstotal_visual_screen_area: Total viewport area in pixels²visual_component_coverage: Area covered by components in pixels²snapshot_name: User-defined name for this coverage snapshotsnapshot_description: Detailed description of the snapshotis_baseline: Whether this is the baseline snapshot for comparisonviewport_width: Browser viewport width in pixelsviewport_height: Browser viewport height in pixelsdevice_type: Device category (desktop, tablet, mobile)user_agent: Browser user agent stringcomponent_breakdown: Detailed JSON structure of all components and their relationshipscomponents: Array of component details including area, nesting, and relationshipshierarchy: Component parent-child relationship treeP0001)The request reached Infa, but the
x-api-keyheader did not hold one of your tokens:x-api-key. NotAuthorization: Bearer, and notapikey(that one carries the fixed public value above).abcd****in the table is a masked preview.The
apikeyheader is missing or altered. Copy the public value above exactly.The key reads boards its own account owns. Check the
p_board_idand which account generated the token.For a complete design system management experience, explore our other integrations:
Need help with API integration? Check out our general documentation for additional guidance on managing your design system with Infa.