Bring your own key
Why BYOK
- You already pay a provider and want to use that quota.
- You want a specific model Flowly Cloud doesn't carry.
- You want billing to sit entirely with the provider, not Flowly.
- You run your own model server (vLLM, an OpenAI-compatible proxy).
/integrations, /provider). The desktop app's save flow writes the Flowly Cloud slot β it won't touch your BYOK keys, so the two coexist safely.Supported providers
| Provider | Slug | Models | Get a key |
|---|---|---|---|
| OpenRouter | openrouter | Hundreds β Claude, GPT, Gemini, Llama, Kimi, β¦ | openrouter.ai/keys |
| Anthropic | anthropic | Claude (Opus, Sonnet, Haiku) | console.anthropic.com |
| OpenAI | openai | GPT family | platform.openai.com |
| xAI | xai | Grok (via API key) | console.x.ai |
| Google Gemini | gemini | Gemini family | aistudio.google.com |
| Groq | groq | Fast open models β also powers voice transcription | console.groq.com |
| Zhipu | zhipu | GLM family | z.ai |
| vLLM / custom | vllm | Any OpenAI-compatible endpoint you host | self-hosted |
Adding a key
One-shot from the CLI β save a key and pin it as the active provider in a single command:
flowly setup byok openrouter # prompts for the key (hidden input)
flowly setup byok anthropic --key sk-ant-... # or pass it inline
flowly setup byok groq --no-set-active # save it but don't switch to it yetValid slugs: openrouter, anthropic, openai, xai, gemini, groq. The key is saved to ~/.flowly/config.json and applies on the next message.
From the terminal chat β for a guided experience with a live connection probe, open the integrations manager:
/integrations # pick a provider card, paste the key, Flowly probes it live
/provider # then switch between every provider you've configuredOnce the key is in, choose the model with /model. See Switching providers & models for the full switcher workflow.
Grok without an API key
If you have a SuperGrok or X Premium+ subscription, you can use Grok in Flowly by signing in with that subscription instead of pasting an xAI API key β no per-token billing. It's set up like an integration rather than a BYOK key:
Self-hosted & custom endpoints
Running your own model server, or pointing at an OpenAI-compatible proxy? Use the vllm slot and set its apiBase to your endpoint. Any provider's apiBase can be overridden the same way β handy for gateways and regional endpoints. The full schema is in the configuration reference.
{
"providers": {
"active": "vllm",
"vllm": {
"apiKey": "EMPTY",
"apiBase": "http://localhost:8000/v1"
}
},
"agents": { "defaults": { "model": "your-served-model-id" } }
}