BYOK & API keys FAQ
What does BYOK mean?
BYOK stands for Bring Your Own Key. Ironspire does not bill you for AI usage. You provide your own API key (or subscription) for each provider you want to use, and your API costs go directly to that provider. Ironspire charges only for the platform features.
Do I need an API key to use Ironspire?
You need credentials for at least one AI model provider. Options include:
- Claude Max or Pro subscription: if you already have a Claude Max or Pro plan, Ironspire can use it through the Claude CLI with no separate API key.
- Anthropic API key: pay-per-token access from console.anthropic.com.
- OpenAI, Gemini, Mistral, DeepSeek, xAI, Bedrock: each needs its own key from the respective provider console.
- Ollama: runs models locally on your machine with no API key or cloud account required.
See the providers overview and configuring providers for step-by-step setup.
Can I use my Claude Max or Claude Pro subscription?
Yes. Set the Claude SDK provider in Settings. Ironspire detects your Claude CLI installation automatically, and if the CLI is installed and authenticated, the health dot turns green. Billing goes through your existing Claude subscription, not per token.
The Claude CLI must be installed and signed in on your machine. Visit claude.ai if you need to install it.
Where are my API keys stored?
API keys are encrypted at rest using your operating system's native credential store:
| Platform | Mechanism |
|---|---|
| Windows | DPAPI via Electron safeStorage |
| macOS | Keychain via Electron safeStorage |
| Linux | libsecret via Electron safeStorage |
Keys are never written to plain-text config files, logs, or state snapshots. They are not included in project exports or analytics data.
Can I use different models for different agents?
Yes. Provider and model selection is per agent, not global. You can run a Claude Opus agent for complex reasoning alongside a local Ollama agent for rapid iteration in the same project. The global default in Settings is used only when creating new agents; each agent can override it independently.
See configuring providers and the model registry for details.
Can I use self-hosted or custom model endpoints?
Yes. Ironspire supports any OpenAI-compatible API endpoint. You can add a custom base URL (for example, a self-hosted model proxy, Azure OpenAI, or a provider not yet built in) under Settings > Providers > OpenAI-Compatible.
See custom endpoints for the setup steps.
How do I know if my API key is working?
The provider card in Settings shows a coloured health dot:
- Green: connection verified, credentials valid
- Yellow: provider is rate-limiting requests
- Red: cannot connect, or credentials were rejected
- Grey: provider not yet configured
Health checks run automatically when you open the Providers tab and after you enter or change credentials. You can also click the refresh icon on any provider card to trigger a manual check.