Skip to content

Commit 27810c4

Browse files
committed
Enhance API Configuration Profiles documentation with detailed setup instructions and new images
1 parent ce04f3c commit 27810c4

11 files changed

+48
-16
lines changed

docs/advanced-usage/api-configuration-profiles.md

Lines changed: 48 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,35 +2,67 @@
22

33
API Configuration Profiles allow you to create and switch between different sets of AI settings. Each profile can have different configurations for each mode, letting you optimize your experience based on the task at hand.
44

5+
:::info
6+
Having multiple configuration profiles lets you quickly switch between different AI providers, models, and settings without reconfiguring everything each time you want to change your setup.
7+
:::
58
## How It Works
69

710
Configuration profiles can have their own:
8-
- API providers (OpenAI, Anthropic, etc.)
9-
- API keys
10-
- Model selections
11+
- API providers (OpenAI, Anthropic, OpenRouter, Glama, etc.)
12+
- API keys and authentication details
13+
- Model selections (o3-mini-high, Claude 3.7 Sonnet, DeepSeek R1, etc.)
1114
- Temperature settings
1215
- Thinking budgets
16+
- Provider-specific settings
1317

14-
This lets you optimize your model configuration for different modes. For instance, you might want Architect and Debug mode to use a more powerful/expensive model to come up with a great plan, while Code mode uses a more standard coding model.
18+
Note that available settings vary by provider and model. Each provider offers different configuration options, and even within the same provider, different models may support different parameter ranges or features.
1519

16-
## Setting Up Profiles
20+
## Creating and Managing Profiles
1721

18-
1. Open Settings → Providers
19-
2. Choose a Configuration Profile from the dropdown, or create a new one
20-
3. Configure the profile's provider, model, key, and parameters
22+
### Creating a Profile
2123

22-
## Linking Profiles to Modes
24+
1. Open Settings by clicking the gear icon <Codicon name="gear" /> → Providers
25+
2. Click the "+" button next to the profile selector
26+
<img src="/img/api-configuration-profiles/api-configuration-profiles-1.png" alt="Profile selector with plus button" width="550" />
27+
3. Enter a name for your new profile
28+
<img src="/img/api-configuration-profiles/api-configuration-profiles.png" alt="Creating a new profile dialog" width="550" />
29+
4. Configure the profile settings:
30+
- Select your API provider
31+
<img src="/img/api-configuration-profiles/api-configuration-profiles-2.png" alt="Provider selection dropdown" width="550" />
32+
- Enter API key
33+
<img src="/img/api-configuration-profiles/api-configuration-profiles-3.png" alt="API key entry field" width="550" />
34+
- Choose a model
35+
<img src="/img/api-configuration-profiles/api-configuration-profiles-8.png" alt="Model selection interface" width="550" />
36+
- Adjust model parameters
37+
<img src="/img/api-configuration-profiles/api-configuration-profiles-5.png" alt="Model parameter adjustment controls" width="550" />
38+
39+
### Switching Profiles
2340

24-
In the <Codicon name="notebook" /> Prompts tab, you can associate a Configuration Profile with each Mode.
41+
Switch profiles in two ways:
42+
1. From Settings panel: Select a different profile from the dropdown
43+
<img src="/img/api-configuration-profiles/api-configuration-profiles-7.png" alt="Profile selection dropdown in Settings" width="550" />
44+
2. During chat: Access the API Configuration dropdown in the chat interface
45+
<img src="/img/api-configuration-profiles/api-configuration-profiles-9.png" alt="API Configuration dropdown in chat interface" width="550" />
2546

26-
## Benefits
47+
### Editing and Deleting Profiles
2748

28-
- **Cost optimization**: Use premium models only where they add the most value
29-
- **Performance tailoring**: Match model capabilities to each mode's specific needs
30-
- **Workflow optimization**: Seamless transitions between modes with appropriate settings
49+
<img src="/img/api-configuration-profiles/api-configuration-profiles-10.png" alt="Profile editing interface" width="550" />
50+
- Select the profile in Settings to modify any settings
51+
- Click the pencil icon to rename a profile
52+
- Click the trash icon to delete a profile (you cannot delete the only remaining profile)
53+
54+
## Linking Profiles to Modes
55+
In the <Codicon name="notebook" /> Prompts tab, you can explicitly associate a specific Configuration Profile with each Mode. The system also automatically remembers which profile you last used with each mode, making your workflow more efficient.
56+
<img src="/img/api-configuration-profiles/api-configuration-profiles-11.png" alt="Profile-Mode association interface in Prompts tab" width="550" />
57+
58+
## Security Note
59+
60+
API keys are stored securely in VSCode's Secret Storage and are never exposed in plain text.
3161

3262
## Related Features
3363

34-
- Works with [custom modes](custom-modes)
64+
- Works with [custom modes](custom-modes) you create
3565
- Integrates with [local models](local-models) for offline work
36-
- Supports [temperature settings](model-temperature) per mode
66+
- Supports [temperature settings](model-temperature) per mode
67+
- Enhances cost management with [rate limits and usage tracking](rate-limits-costs)
68+
48.7 KB
Loading
14.9 KB
Loading
118 KB
Loading
49.5 KB
Loading
20.1 KB
Loading
34.4 KB
Loading
55.2 KB
Loading
57.4 KB
Loading
84.2 KB
Loading

0 commit comments

Comments
 (0)