OpenRouter configuration guide
Choosing an integration method, creating your OpenRouter API key, and setting up BYOK or OpenRouter managed providers.
OpenCRM supports three AI integration methods. You must choose one integration method within OpenCRM.
This guide covers the OpenRouter option.
Step 1: Create an OpenRouter account and API key
QHow do I create an OpenRouter account?
Before configuring any models, create an OpenRouter account and generate an API key.
- Register for an OpenRouter account.
- Verify your email address.
- Sign in to your OpenRouter account.
QHow do I create an API key?
- From the left-hand menu, select API Keys.
- Click + New Key.
- Complete the fields as required:
- Owner: Select the appropriate owner.
- Name: Enter a meaningful name, for example OpenCRM Integration.
- Expiration: Select the desired expiry period.
- Credit Limit: Optionally set a spending limit for the key.
- Click Create.
- Copy and securely store the generated API key.
Once the API key has been created, choose one of the following configuration options.
Option 1: Bring Your Own Provider Key (BYOK)
QWhen should I use BYOK?
Use this option when you already have accounts with one or more AI providers and want usage billed directly to those providers. Examples include:
- OpenAI (GPT models)
- Google (Gemini models)
- Anthropic (Claude models)
- xAI (Grok models)
- Mistral
- Other supported providers
The full list of supported providers can be found in the OpenRouter Providers Directory: openrouter.ai/providers
QHow do I configure BYOK?
- Create an account with your chosen AI provider(s).
- Generate an API key from each provider you wish to use.
- In OpenRouter, navigate to Settings → Providers.
- Add your provider API key(s).
- Configure model routing to use your selected provider(s).
- Disable provider fallbacks if you want requests to use only your own provider accounts.
- Configure OpenCRM using the OpenRouter API key created earlier.
- Select your required model(s) and test the connection.
QExample: how do I use Claude via OpenRouter?
- Create an Anthropic account.
- Generate an Anthropic API key.
- Add the Anthropic key to OpenRouter.
- Select the required Claude model.
- Optionally restrict routing to Anthropic only.
QWhat is the result?
- Usage is billed directly by the model provider.
- You maintain a direct relationship with the provider.
- OpenRouter acts as a routing and compatibility layer.
- Multiple providers can be accessed through a single OpenRouter endpoint while retaining direct control of billing and provider access.
Option 2: Use OpenRouter managed providers
QWhen should I use OpenRouter managed providers?
Use this option when you do not want to create or manage separate provider accounts.
QHow do I configure managed providers?
- Add credit to your OpenRouter account.
- Select the required model from the OpenRouter catalogue.
- Leave provider routing set to OpenRouter defaults or specify a preferred provider if required.
- Configure OpenCRM using the OpenRouter API key created earlier.
- Test the connection.
QWhat is the result?
- No separate provider accounts are required.
- No provider API keys are required.
- Billing is handled entirely through OpenRouter.
- This is typically the quickest and simplest way to get started.
Settings in OpenCRM
QWhat do I enter in the "API Model" field?
Enter the model you want to use with OpenRouter. The value you need is shown underneath the model name on the model information page in OpenRouter, for example:
anthropic/claude-sonnet-5.5
Alternatively, enter openrouter/auto to use OpenRouter's automatic routing. This will use the models you have limited it to in your OpenRouter configuration.
QIf I'm using BYOK, what do I enter in the "Allowed Providers" field?
Set this to only the providers you have keys set up with, separated by commas, for example:
anthropic,openai,google
Why this matters: the same model is often available through more than one provider. Limiting which models your API key can use does not limit which provider OpenRouter uses to reach them. Without this setting, OpenRouter may send your request through a provider outside your BYOK setup, for example using an OpenAI model via Amazon Bedrock instead of via OpenAI directly.
This applies whether or not you are using automatic routing.
Selecting the right approach
| Requirement | Recommended integration |
|---|---|
| OpenAI only | OpenAI Direct Integration |
| Gemini only | Gemini Direct Integration |
| Claude only | OpenRouter with Anthropic BYOK |
| Multiple providers with your own API keys | OpenRouter with BYOK |
| Single OpenRouter-managed billing relationship | OpenRouter Managed Providers |
If you want to use multiple AI providers with your own provider accounts and API keys, select OpenRouter within OpenCRM and add all of your BYOK credentials to OpenRouter.
For example, a single OpenRouter account could contain:
OpenCRM then connects to OpenRouter using a single OpenRouter API key while OpenRouter manages routing to the appropriate provider. This provides a single integration point within OpenCRM while maintaining direct ownership of your provider accounts, usage and billing.
This guide is general guidance. OpenRouter and provider menus, features and policies change over time, so please check current terms with your chosen provider. For help configuring Oi, contact the OpenCRM support team.
Need More Help?
If you have any questions, just start a Live Chat, "Click" on the Chat Icon in the lower right corner to talk with our support team.