Authentication#
To use our API, you'll need to authenticate your requests using an API key. This guide will walk you through creating and using API keys.
Creating an API Key#
Before making API requests, you must generate an API key from your account:2.
Open Profile Settings
In the top-right corner of the Dashboard, click on your profile avatar and select Manage Account from the dropdown menu.
3.
Access the API Keys Section
Within the Manage Account page, navigate to the API Keys tab in the left-hand menu.
4.
Create a New API Key
If you haven't created any keys yet, you’ll see an empty state and a button labeled Create API Key.
Click Create API Key, provide a name for the key (e.g., ProductionKey
, TestEnvKey
), and confirm the creation.5.
Copy and Store the API Key Securely
After generation, your new API key will be displayed once. The key is partially masked for security.
⚠️ Important: Copy your API key immediately and store it securely (e.g., in an environment variable or secrets manager). You won’t be able to retrieve it again after navigating away.
Using Your API Key#
Once you have your API key, include it in the headers of all API requests as follows:Modified at 2025-04-23 14:50:35