Skip to content

Update to API key config for Shift. #340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Corb3nik merged 1 commit into from
Mar 2, 2026
Merged

Update to API key config for Shift. #340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file removed src/_images/shift_api_key.png
View file
Open in desktop
Binary file not shown.
12 changes: 3 additions & 9 deletions src/app/tutorials/shift.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,17 +48,11 @@ Shift is highly capable and should be able to carry out any task you could do wi

## Configuration

To use Shift, register/login to [https://openrouter.ai/](https://openrouter.ai/) and obtain an [API key](https://openrouter.ai/settings/keys).
To use Shift, **click** on the account button <code><Icon icon="fas fa-user" /></code> in the top-right corner of the Caido user-interface, select `Settings`, and open the `AI` tab.

::: warning NOTE
Certain models can be used for [free](https://openrouter.ai/models?q=free) while others cost [credits](https://openrouter.ai/settings/credits). Actively monitor usage and consider setting a budget to avoid high costs.
:::

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.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
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).

Copilot uses AI. Check for mistakes.

Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
<img alt="The AI settings tab in Shift showing where to enter the API key." src="/_images/shift_ai_settings.png" center />

Copilot uses AI. Check for mistakes.
Copy link

Copilot AI Feb 27, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
::: 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.
:::

Copilot uses AI. Check for mistakes.
Within the `Settings` interface, there are also options to limit the number of API calls a Shift Agent can make and an input field to provide a general system prompt or more contextual information about your target.
Within the `Settings` interface of Shift, there are also options to limit the number of API calls a Shift Agent can make and an input field to provide a general system prompt or more contextual information about your target.

<img alt="Additional Shift settings." src="/_images/shift_settings.png" center />

Expand Down
Loading