Skip to main content

Chatbox with OpenCheese

/ API docs

← API quickstartView as Markdown

Chatbox runs on Android, iOS, Windows, macOS and Linux, and works with OpenCheese as a custom provider in the OpenAI format. The setup is the same in every version.

Add the provider

  1. Open Settings from the sidebar, then Model Provider.
  2. Click Add at the bottom of the provider list.
  3. Give it a name (for example OpenCheese) and choose OpenAI API Compatible as the API mode.
  4. Fill in:
Field Value
API Key your OpenCheese API key
API Host https://api.opencheese.dev/v1
API Path empty (Chatbox uses /chat/completions)
  1. Add at least one model: fetch the list or type a model ID from /v1/models. Mark the model's abilities, such as vision or tool use, to match its modalities and capabilities; a model without them is treated as text-only.
  2. Save and click Check: it should report a successful connection.

With the path left empty, Chatbox adds /v1 when the host has none, so https://api.opencheese.dev works too.

Use it

Start a new conversation and pick an OpenCheese model in the model selector. For pictures, use an image model through the Image API or the dashboard's AI Images.

Usage

Every request appears in the dashboard's Transactions. Chatbox does not tell the gateway which conversation a request belongs to, so each request shows as its own session for now.

Troubleshooting

To rule out the app, check the key and the model IDs from a computer:

bash
curl -s https://api.opencheese.dev/v1/models \
  -H "Authorization: Bearer $OPENCHEESE_API_KEY" | jq -r '.data[].id'
  • "Invalid or disabled OpenCheese API key": the key was copied incompletely or switched off on the API keys page.
  • The model is not found: model IDs are exact; copy them from /v1/models.
  • The website answers instead of the API: the host must be api.opencheese.dev, not opencheese.dev.
The cheese has holes. Your infrastructure should not.