API Key Requirements
This document details the API key requirements for using different agents and models within the application. Understanding these requirements ensures you can fully utilize all available features and integrate seamlessly with various AI providers.
General Information
- Why API Keys? API keys are unique identifiers that authenticate your requests to external AI service providers (e.g., Anthropic, OpenAI, Gemini). They allow the application to access these services on your behalf.
- Vercel AI Gateway: The Vercel AI Gateway acts as a smart proxy. It centralizes routing and management of requests to various AI models. While it simplifies integration and offers additional features, it still uses your provided API keys to authenticate with the underlying AI services. Think of it as a secure and efficient dispatcher that uses your credentials.
Managing Your API Keys
To input and manage your API keys within the application:
- Click on your User Avatar located in the top right corner of the application.
- From the dropdown menu, select API Keys.
- Here, you can enter, replace, or delete your API keys for various providers. Your keys are stored securely.
For more detailed instructions on managing your API keys, including security notes, please refer to the Settings documentation.
Agent-Specific API Key Requirements
Here’s a breakdown of the API key requirements for each agent:
Claude Agent
- Required Key: Anthropic API Key
- Details: To use any of the Claude models (e.g., Claude Opus, Claude Sonnet, Claude Haiku), you must provide a valid Anthropic API key.
Codex Agent
- Required Key: OpenAI API Key (used via Vercel AI Gateway)
- Details: Codex models, which are often based on OpenAI's GPT architecture, leverage the Vercel AI Gateway for communication. The AI Gateway will use your OpenAI API Key to authenticate requests to OpenAI's services. Therefore, you need an OpenAI API Key to use the Codex agent effectively.
Copilot Agent
- Required Key: None (uses GitHub account token)
- Details: The Copilot agent automatically utilizes your connected GitHub account token for authentication. You do not need to provide a separate API key for Copilot, provided your GitHub account has the necessary permissions.
Cursor Agent
- Required Key: Cursor API Key
- Details: To use the Cursor agent and its associated models, you must provide a valid Cursor API Key.
Gemini Agent
- Required Key: Gemini API Key
- Details: To use any of the Gemini models (e.g., Gemini 3.1 Pro, Gemini 3 Flash), you must provide a valid Gemini API Key.
OpenCode Agent
- Required Key: Dynamic (depends on selected model)
- Details: The API key required for the OpenCode agent is dynamic and depends on the specific model you choose within the OpenCode selection:
- Anthropic Models (e.g., Claude variants): If you select a Claude model, an Anthropic API Key is required.
- OpenAI/GPT Models: If you select an OpenAI/GPT model, the agent will use the Vercel AI Gateway, which in turn requires your OpenAI API Key.
By ensuring you have the correct API keys configured, you can seamlessly interact with all the powerful AI agents and models available in the application.