Bring Your Own Model (BYOM)

BYOM lets Institutional plan organisations supply their own Anthropic API key for AI Insights. When a key is configured, Opsion uses it for every AI Insights query instead of the platform default — your usage appears on your own Anthropic invoice and your rate limit is raised from 20 to 200 queries per hour.

💡

Institutional plan only

BYOM is available exclusively on the Institutional plan. The setting is hidden for all other plans. View plans →

Prerequisites

An active Opsion Institutional subscription.
An Anthropic API key starting with sk-ant-. Create one at console.anthropic.com.
Owner or Admin role in your Opsion organisation.

Setup

Open the Opsion console and go to Settings.
Scroll to the AI Insights — Bring Your Own Model card.
(This card is only visible on the Institutional plan.)
Paste your Anthropic API key into the input field.
Click Save.

Once saved, the field displays a masked placeholder (sk-ant-••••••••••••••••) and a green confirmation indicator. All subsequent AI Insights queries will use your key.

✦

Test your key

After saving, run any AI Insights query. If the key is invalid you will see an error:"Your organisation's Claude API key is invalid. Update it in Settings → AI Insights." Paste a corrected key and save again.

Removing the key

Click the Remove button next to the masked key display. Opsion will delete the stored key and revert to the platform default for subsequent queries. The rate limit drops back to 20 queries per hour.

Rate limits

Configuration	Limit	Window
Platform default key	20 queries	Rolling 60 min
BYOM key configured	200 queries	Rolling 60 min

The higher BYOM limit exists because Opsion bears no API cost when you supply your own key. The 200-query cap is a soft abuse guard — contact support if your use case requires more.

Security

Stored server-side only— your key is persisted in your organisation's encrypted settings. It is never returned to the browser after saving. API responses replace it with a boolean flag (claudeApiKeySet: true).
Server-to-server use only— the key travels only between Opsion's internal backend services (gateway → web API route) when processing a query. It is never included in any response sent to a browser or API client.
Role-gated writes — only users with the Owner or Admin role can set or remove the key via the API or console.
Plan-gated writes — the gateway enforces that only Institutional or Custom plan organisations can save a BYOM key. A downgrade removes the key from future queries (it remains stored until explicitly removed or the plan is restored).

⚠

Rotate compromised keys immediately

If you suspect your Anthropic API key has been compromised, revoke it at console.anthropic.com immediately, then paste a new key in Opsion Settings. Opsion has no ability to use a key that has been revoked at the Anthropic level.

Error handling

Error	Cause	Resolution
Invalid API key	The stored key has been revoked or is malformed	Paste a valid key in Settings → AI Insights
Rate limit reached (200/hour)	Query volume exceeded the BYOM cap	Wait for the rolling window to reset, or contact support
Bring Your Own Model requires the Enterprise plan	Attempted to save a key on a non-Institutional plan	Upgrade to Institutional