Skip to content

Commit b8e2cb6

Browse files
committed
docs: update connecting API provider instructions and add images for clarity
1 parent 2bcacdc commit b8e2cb6

File tree

5 files changed

+46
-31
lines changed

5 files changed

+46
-31
lines changed

docs/getting-started/connecting-api-provider.md

Lines changed: 46 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,73 @@ sidebar_label: Connecting To A Provider
44

55
# Connecting Your First AI Provider
66

7-
To get started, you'll need to connect Roo Code to an AI model provider. We recommend starting with one of these options, which all offer access to Anthropic's powerful **Claude 3.7 Sonnet** model:
7+
Roo Code requires an API key from an AI model provider to function. We recommend these options for accessing the powerful **Claude 3.7 Sonnet** model:
88

9-
1. **OpenRouter (Recommended):** A platform that provides access to multiple AI models, including Claude 3.7 Sonnet. This is often the easiest option for getting started.
10-
11-
2. **Anthropic:** Direct access to Claude models from Anthropic. Requires applying for API access, and may be rate limited depending on your tier.
12-
13-
Choose one of these options and follow the instructions below to obtain an API key.
9+
- **OpenRouter (Recommended):** Provides access to multiple AI models through a single API key. Ideal for getting started quickly with minimal setup. [View pricing](https://openrouter.ai/models?order=pricing-low-to-high).
10+
- **Anthropic:** Direct access to Claude models. Requires API access approval and may have [rate limits depending on your tier](https://docs.anthropic.com/en/api/rate-limits#requirements-to-advance-tier). See [Anthropic's pricing page](https://www.anthropic.com/pricing#anthropic-api) for details.
1411

1512
## Getting Your API Key
1613

17-
### Option 1: Using an LLM router
14+
### Option 1: LLM Routers
1815

19-
LLM routers allow you to use multiple models via a single provider, simplifying cost and API key management.
16+
LLM routers let you access multiple AI models with one API key, simplifying cost management and switching between models. They often offer [competitive pricing](https://openrouter.ai/models?order=pricing-low-to-high) compared to direct providers.
2017

2118
#### OpenRouter
2219

23-
1. **Go to the OpenRouter website:** [https://openrouter.ai/](https://openrouter.ai/)
24-
2. **Sign in** with your Google or GitHub account.
25-
3. **Get an API Key:** Go to the [keys page](https://openrouter.ai/keys) and create a key. Copy the key.
20+
1. Go to [openrouter.ai](https://openrouter.ai/)
21+
2. Sign in with your Google or GitHub account
22+
3. Navigate to the [API keys page](https://openrouter.ai/keys) and create a new key
23+
4. Copy your API key - you'll need this for Roo Code setup
24+
25+
<img src="/img/connecting-api-provider/connecting-api-provider-4.png" alt="OpenRouter API keys page" width="600" />
26+
27+
*OpenRouter dashboard with "Create key" button. Name your key and copy it after creation.*
2628

2729
#### Requesty
2830

29-
1. **Go to the Requesty website:** [https://requesty.ai/](https://requesty.ai/)
30-
2. **Sign in** with your Google or email account
31-
3. **Get an API Key:** Go to the [API management page](https://app.requesty.ai/manage-api) and create a key. **Important:** Copy the key immediately, as you won't be able to see it again.
31+
1. Go to [requesty.ai](https://requesty.ai/)
32+
2. Sign in with your Google account or email
33+
3. Navigate to the [API management page](https://app.requesty.ai/manage-api) and create a new key
34+
4. **Important:** Copy your API key immediately as it won't be displayed again
35+
36+
<img src="/img/connecting-api-provider/connecting-api-provider-7.png" alt="Requesty API management page" width="600" />
37+
38+
*Requesty API management page with "Create API Key" button. Copy your key immediately - it's shown only once.*
3239

33-
### Option 2: Using an LLM provider directly
40+
### Option 2: Direct Providers
3441

35-
If you prefer to use a specific LLM provider directly, that is always an option.
42+
For direct access to specific models from their original providers, with full access to their features and capabilities:
3643

3744
#### Anthropic
3845

39-
1. **Go to the Anthropic Console:** [https://console.anthropic.com/](https://console.anthropic.com/)
40-
2. **Sign up** for an account or log in.
41-
3. **Create an API Key:** Go to the API keys page (you may need to navigate through the dashboard) and create a new key. **Important:** Copy the key immediately, as you won't be able to see it again.
46+
1. Go to [console.anthropic.com](https://console.anthropic.com/)
47+
2. Sign up for an account or log in
48+
3. Navigate to the [API keys section](https://console.anthropic.com/settings/keys) and create a new key
49+
4. **Important:** Copy your API key immediately as it won't be displayed again
4250

43-
#### OpenAI
51+
<img src="/img/connecting-api-provider/connecting-api-provider-5.png" alt="Anthropic console API Keys section" width="600" />
4452

45-
1. **Go to the OpenAI Console:** [https://platform.openai.com/](https://platform.openai.com/)
46-
2. **Sign up** for an account or log in.
47-
3. **Create an API Key:** Go to the API keys page (you may need to navigate through the dashboard) and create a new key. **Important:** Copy the key immediately, as you won't be able to see it again.
53+
*Anthropic console API Keys section with "Create key" button. Name your key, set expiration, and copy it immediately.*
4854

49-
## Configuring Roo Code in VS Code
55+
#### OpenAI
5056

51-
1. **Open the Roo Code Sidebar:** Click the Roo Code icon (<Codicon name="rocket" />) in the VS Code Activity Bar. You should see the welcome screen.
57+
1. Go to [platform.openai.com](https://platform.openai.com/)
58+
2. Sign up for an account or log in
59+
3. Navigate to the [API keys section](https://platform.openai.com/api-keys) and create a new key
60+
4. **Important:** Copy your API key immediately as it won't be displayed again
5261

53-
2. **Select your API Provider:** In the "API Provider" dropdown, choose your API provider.
62+
<img src="/img/connecting-api-provider/connecting-api-provider-6.png" alt="OpenAI API keys page" width="600" />
5463

55-
3. **Enter your API Key:** Paste your API key into the "API Key" field.
64+
*OpenAI platform with "Create new secret key" button. Name your key and copy it immediately after creation.*
65+
66+
## Configuring Roo Code in VS Code
5667

57-
4. **Select your Model:**
58-
* If you're using **OpenRouter**, select `anthropic/claude-3.7-sonnet`.
59-
* If you're using **Anthropic**, select `claude-3-7-sonnet-20250219`.
68+
Once you have your API key:
6069

61-
5. **Click "Let's go!":** Roo Code will save your settings, and you'll be ready to start coding!
70+
1. Open the Roo Code sidebar by clicking the Roo Code icon (<Codicon name="rocket" />) in the VS Code Activity Bar
71+
2. In the welcome screen, select your API provider from the dropdown
72+
3. Paste your API key into the appropriate field
73+
4. Select your model:
74+
- For **OpenRouter**: select `anthropic/claude-3.7-sonnet` ([model details](https://openrouter.ai/anthropic/claude-3.7-sonnet))
75+
- For **Anthropic**: select `claude-3-7-sonnet-20250219` ([model details](https://www.anthropic.com/pricing#anthropic-api))
76+
5. Click "Let's go!" to save your settings and start using Roo Code
180 KB
Loading
189 KB
Loading
176 KB
Loading
154 KB
Loading

0 commit comments

Comments
 (0)