Creating an API key
1
Go to settings
Open your dashboard settings and find the API Keys section.
2
Create a key
Click Create API Key and fill in:
- Name — a descriptive name for the key (3–50 characters), e.g., “Production Backend” or “Testing”
- Agent scope — choose All Agents to access any agent, or select a specific agent to restrict access
3
Copy the key
Your API key is displayed once after creation. Copy it immediately — you won’t be able to see the full key again.The key format looks like:
Using an API key
Include your API key in theAuthorization header of API requests:
Key limits
Agent scope
Use agent-specific keys when you want to limit access — for example, giving a key to a third-party integration that should only access one agent.
Managing keys
In the API Keys section of your settings, you can see all your keys with:- Name — the key’s label
- Key prefix — the first characters of the key (for identification)
- Agent scope — which agents the key can access
- Last used — when the key was last used in an API request
- Status — active or inactive