OpenRouter integration
Use this guide to connect OpenRouter to ReplyRabbit for a FreeScout mailbox. OpenRouter acts as the AI generation provider, while ReplyRabbit stays responsible for the FreeScout support workflow.
Looking for the overview?
Overview
OpenRouter is one of ReplyRabbit's cloud AI provider options. You can select OpenRouter in the mailbox AI Provider settings, paste your OpenRouter API key, and choose a configured model option or custom model ID.
ReplyRabbit uses the provider for generation, then returns the draft or suggestion to FreeScout for agent review.
Because OpenRouter can route to many model families, ReplyRabbit does not send a generic prompt cache control setting through OpenRouter. It records cache usage metadata when OpenRouter or the routed provider returns it.
Prerequisites
Before you start, make sure you have:
- A working FreeScout installation.
- ReplyRabbit installed and activated.
- ReplyRabbit Pro or Team, which unlocks all AI providers.
- An OpenRouter account.
- An OpenRouter API key.
- Access to the OpenRouter model or routing option you plan to use.
If you are still choosing a provider, read Choosing an AI provider.
Permissions and API keys
ReplyRabbit uses your OpenRouter API key only when the mailbox provider is set to OpenRouter. Saved keys are stored as secrets and shown masked after saving.
AI usage and model access are governed by your OpenRouter account. If a model is unavailable there, ReplyRabbit cannot use it.
Connect OpenRouter
Open ReplyRabbit settings
In FreeScout, open the mailbox, go to Settings, and choose ReplyRabbit.Choose OpenRouter
In the AI Provider card, select OpenRouter.Paste the API key
Paste your OpenRouter API key into API Key.Choose a model
Choose the configured auto-router option, a listed preset, or Custom if your team has a specific OpenRouter model ID.Save and test
Save settings, open a FreeScout conversation, and generate a test draft. Review quality and cost before using OpenRouter on a busy mailbox.
Configuration notes
- Provider: choose OpenRouter in the AI Provider card.
- API key: use a key from your own OpenRouter account.
- Model: choose auto-router, a preset, or a custom OpenRouter model ID.
- Prompt caching: no OpenRouter cache toggle is required. Cache usage is recorded when provider metadata includes it.
- Budget: set a monthly token budget if you want ReplyRabbit to stop generation after a configured mailbox limit.
- Embeddings: OpenRouter is not configured as an embedding provider in ReplyRabbit.
Use cases
- Try several hosted model families through one provider account.
- Use OpenRouter auto-router for a mailbox where provider routing is useful.
- Compare provider quality without changing the FreeScout support workflow.
Troubleshooting
| Symptom | What to check |
|---|---|
| OpenRouter is disabled | Confirm the mailbox is on ReplyRabbit Pro or Team. |
| Invalid API key error | Re-copy the key from OpenRouter and confirm it is active. |
| Model is not available | Confirm the model ID exists and your OpenRouter account can access it. |
| Drafts cost more than expected | Review the selected model and set a mailbox token budget. |
| Semantic retrieval is not using OpenRouter | Choose a supported embedding provider, or rely on the configured fallback behavior. |
For broader fixes, see Troubleshooting ReplyRabbit.
Privacy and security notes
When OpenRouter is selected, ReplyRabbit sends OpenRouter the prompt context needed for the AI feature. Depending on the model routed by OpenRouter, provider-side processing may involve other model vendors according to your OpenRouter account and settings.
Use a local provider such as Ollama if your policy requires customer content to stay on your own hardware.
Next steps
- Review the OpenRouter integration for FreeScout page when you need the workflow and buying overview.
- Compare provider tradeoffs in Choosing an AI provider before changing a production mailbox.
- Continue with How to set up ReplyRabbit if company context, examples, or budgets still need attention.
FAQ
Do I need an OpenRouter API key?
Yes. ReplyRabbit uses the OpenRouter API key you provide in the mailbox settings.
Can I use OpenRouter Auto Router?
Yes. ReplyRabbit includes a configured OpenRouter auto-router option.
Can I use a custom OpenRouter model ID?
Yes. Use the Custom option when your team has a provider-supported OpenRouter model ID.
Does ReplyRabbit send prompt cache settings through OpenRouter?
No. OpenRouter can route many model families, so ReplyRabbit avoids generic cache-control request fields and records cache metadata only when the provider returns it.
Does OpenRouter handle semantic retrieval embeddings?
OpenRouter is not configured as an embedding provider in ReplyRabbit, so choose a supported embedding provider if semantic retrieval is needed.