Connect your app
Every client needs the same three things: where plugboard is, a plugboard key, and a model name. The only choice is which API your app speaks.
| Setting | Value |
|---|---|
| Address | http://127.0.0.1:4010 (change it if you changed listen) |
| Key | a key from the keys option. Not a provider key |
| Model | an alias from aliases, or provider/model[#variant] from models |
GET /v1/models lists the model names this key may use.
Choose by API
| The app speaks | Base URL | Key goes in | Read |
|---|---|---|---|
| OpenAI (Chat Completions, most apps) | http://127.0.0.1:4010/v1 | Authorization: Bearer <key> | Chat Completions |
| OpenAI Responses | http://127.0.0.1:4010/v1 | Authorization: Bearer <key> | Responses |
| Anthropic | http://127.0.0.1:4010 (the SDK adds /v1/messages) | x-api-key or Authorization: Bearer | Messages |
| Gemini | http://127.0.0.1:4010 (the SDK adds /v1beta) | x-goog-api-key | Gemini |
Old completions scripts | http://127.0.0.1:4010/v1 | Authorization: Bearer <key> | Completions |
If an app only asks for "an OpenAI-compatible URL", use the first row. See Any OpenAI-compatible app for the settings every such app shares and the gotchas.
Choose by client
Each client page shows the settings, working code or config, and the limits to know about. The clients overview lists all of them.
| You use | Start here |
|---|---|
| An SDK in your language | SDKs: OpenAI Python, OpenAI JS, Anthropic Python, Anthropic JS, Google GenAI JS, Go, .NET, Rust |
| An agent framework | Agent frameworks: LangChain, LlamaIndex, CrewAI, pydantic-ai, Vercel AI SDK |
| A chat app | Chat apps: Open WebUI, LibreChat, n8n, Chatbox |
| A coding tool | Coding tools: Claude Code, Codex CLI, OpenCode, Cline, Aider |
| An evaluation or tracing tool | Evaluation and observability: promptfoo, lm-evaluation-harness, Langfuse |
| A self-hosted app such as Karakeep or Mealie | Self-hosted apps |
| Something else | Any OpenAI-compatible app |
The app runs somewhere else
127.0.0.1 only reaches plugboard from the OpenCode host. From another machine or a container you must bind a reachable address, set keys, and limit who can connect. See Serving other machines.
Next
- Apps and keys: give each tool its own key.
- Models, aliases and fallbacks: choose what the app may call.