Conversation
caidobot
temporarily deployed
to
AP-Shift-Config - documentation PR #340
Render
Destroyed
There was a problem hiding this comment.
Pull request overview
This PR updates the Shift tutorial documentation to reflect a change in how API keys are configured. Instead of obtaining an API key from OpenRouter and entering it in the Shift interface directly, users now configure API keys in the main Caido settings (Account → Settings → AI tab).
Changes:
- Relocated API key configuration from Shift-specific instructions to general Caido settings
- Removed OpenRouter-specific instructions and cost warning
- Updated configuration steps to be provider-agnostic
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| <img alt="Adding the API key in Shift." src="/_images/shift_api_key.png" center /> | ||
| Enter your API key for your provider and **click** on the `Verify` button. | ||
|
|
There was a problem hiding this comment.
An image reference has been removed without being replaced. The previous version included an image showing how to add the API key in Shift. While the instructions have changed to use the Settings menu instead, users would still benefit from a visual guide showing where to enter the API key in the AI settings tab. Consider adding a screenshot showing the AI settings tab interface.
| <img alt="The AI settings tab in Shift showing where to enter the API key." src="/_images/shift_ai_settings.png" center /> |
| Copy the key to your clipboard, navigate to the `Settings` tab of the Shift interface, and paste it into the `Enter API key` input field. | ||
|
|
||
| <img alt="Adding the API key in Shift." src="/_images/shift_api_key.png" center /> | ||
| Enter your API key for your provider and **click** on the `Verify` button. |
There was a problem hiding this comment.
The instruction lacks specificity about which provider's API key should be entered and where to obtain it. The previous version specifically mentioned OpenRouter with a link for registration and key generation. Now that the configuration is more generic (supporting multiple providers), users need guidance on which providers are supported and how to obtain their API keys. Consider adding information about supported providers or linking to relevant documentation about provider options.
| Enter your API key for your provider and **click** on the `Verify` button. | |
| Enter the API key for your chosen AI provider (for example OpenAI, OpenRouter, or another provider supported in your Caido setup), and then **click** on the `Verify` button. If you're unsure which providers are available or how to obtain an API key, see the [AI providers documentation](/app/guides/ai_providers.md). |
|
|
||
| <img alt="Adding the API key in Shift." src="/_images/shift_api_key.png" center /> | ||
| Enter your API key for your provider and **click** on the `Verify` button. | ||
|
|
There was a problem hiding this comment.
Important information about cost monitoring has been removed. The previous version warned users that certain models cost credits and recommended setting a budget to avoid high costs. This is critical information for users to avoid unexpected charges. Consider adding back a warning about monitoring API usage and costs, even if it's no longer specific to OpenRouter.
| ::: warning | |
| Many AI/LLM providers charge per request or per token. Make sure you understand your provider's pricing, monitor your API usage and costs, and configure budgets/quotas in your provider account. You can also use Shift's request limits to help prevent unexpected high usage. | |
| ::: |
Closes #339