AI Keys
AI keys let external tools and applications call your AI providers through ACTIVATE's OpenAI-compatible API. Requests made with a key go through the same access checks as Chat, and provider credentials never leave the platform.
Kinds of Key
Two kinds of key work with the OpenAI-compatible API:
- AI Gateway API key: bound to a budget allocation when you create it. It can call only the AI endpoints (
/api/openai/v1/chat/completions,/api/openai/v1/responses, and/api/openai/v1/models). Usage on organization providers is charged to the key's allocation, and once that allocation's budget is exhausted, further requests to organization providers are rejected before they reach a model. Usage made with the key can be broken down per key on the AI Usage dashboard. - API key (a platform API key): not bound to an allocation, and also works with the rest of the ACTIVATE API. It reaches your personal providers, providers shared with you, and session models. To use organization providers with it, send the allocation name in the
X-Allocationheader.
Both kinds reach personal providers and session models, which are not metered. Use an AI Gateway API key when you have an allocation, so organization providers are available and their usage is tracked. If you have no allocations you can use, the AI Gateway API key option has none to choose from, and organization providers are unavailable to external tools.
Managing Keys
Keys belong to your user account; each user creates and manages their own. To manage your AI Gateway API keys, navigate to AI > AI keys in the sidebar.
The page lists each key with its creation date, expiration date, when it was last used, and its allocation. Use the Filter keys field to search the list.
To create a key:
- Click Create key.
- Choose the key type. AI Gateway API key is the default; you can also create an API key or a short-lived Token from the same dialog.
- Enter a Key name and choose when it Expires.
- For an AI Gateway API key, choose an Allocation.
- Create the key and copy it.
Note
Keys are shown once at creation. Store them in a password manager; once you navigate away, you won't be able to see the key again.
To revoke a key, open its row menu and choose Delete.
Platform API keys are listed on the Authentication settings page, not on AI keys.
Using a Key with the OpenAI-Compatible API
Existing OpenAI SDKs and tools work when pointed at ACTIVATE instead of directly at a vendor. Send requests under https://<your-activate-domain>/api/openai/v1, for example to /api/openai/v1/chat/completions, with the key in the Authorization: Bearer <key> header. Model IDs look like owner:provider/model, org:provider/model, or session:owner:session/model; see Model IDs.
For step-by-step setup guides for tools like Open WebUI, OpenCode, Kilo Code, and Cursor, see Connect External Tools.
Related Documentation
- AI Providers: Connect the model backends behind the API
- Organization Providers: Metered providers and allocations
- AI Usage: Track spend and tokens on organization providers
- Chat: Using the chat interface