API keys
API keys provide a secure way to connect Studio to external platforms like Figma. These keys enable seamless integration while ensuring secure authentication.
Accessing the API Key Page
There are multiple ways to navigate to the API Keys page:
From the Project Dashboard
Open your Project Dashboard.
Click on Create an API Key to access the API Key management page.
From the User Panel
Locate the left-side panel of the interface.
Click on the API Keys option to navigate directly to the API management page.
Using a Keyboard Shortcut
Press Cmd + K (Mac) or Ctrl + K (Windows) to open the Quick Menu.
Type "API Key" in the search bar.
Select Manage API Keys to be redirected to the API Key page.
Creating a New API Key
🚨 Important: Once created, the API key will only be shown once. Make sure to copy and store it securely.
To generate a new API Key:
Navigate to the API Keys page.
Click on Create New Token
Enter a name for your API key.
This should something easily identifiable for future reference.
Set the expiration period for the key.
For additional security, you can choose to have the token become non-functional after a set period of time.
Set the scope of the key.
Choose the data and actions that users and tools using the token can access and perform.
If you're using the Tokens Studio for Figma Plugin or the Companion by Tokens Studio plugin, you'll need to enable project:read , project:write and actor_tokens:create
me:read
Read account data for the currently logged in user.
organizations:read
Read data about the organization
organizations:write
Update data and settings for the organization
organizations:admin
Administer organization data
organizations:user:read
Read data regarding the users in an organization
organizations:user:invite
Can invite users to an organizations
organizations:user:write
Can update user data in an organization
projects:read
Read project data directly
projects:write
Update project data
projects:admin
Administer Projects
actor_tokens:create
Create actor tokens for the user
Managing API Keys
The API Keys page displays a list of previously created keys.
You can delete old keys when they are no longer needed.
For security, API keys cannot be viewed again after creation.
Using API Keys
API keys can be used to authenticate connections between Studio and Figma (or other external platforms).
They are tied to your user account, meaning they grant access to all organizations and projects you are part of.
For more details on using API keys for Figma integration, refer to the Connecting Studio to Figma guide.
Security Best Practices
Store API keys in a secure password manager.
Avoid sharing API keys publicly or committing them to version control.
Regularly rotate keys to maintain security.
Related
Last updated