> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tokios.com/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Tokios exposes private local models through https://api.tokios.com using an outbound-only connector tunnel.
> Use 'connector' for the local tokios-connector process.
> Use 'deployment' for the public model name in the API model field.
> Use 'upstream model id' for the model served by Ollama, llama.cpp, vLLM, LM Studio, or another local backend.
> API keys use the prefix sk-tok-. Connector tokens use the prefix ct-tok-.

# Use Msty with your own local model

> Add Tokios as an OpenAI-compatible remote model provider in Msty so the desktop app can reach a model running on your own hardware.

Msty is a polished desktop app for chatting with local and remote models, popular for its side-by-side multi-model chats. Add Tokios as an **OpenAI Compatible** remote model provider — point it at `https://api.tokios.com/v1` with your `sk-tok-…` key — and Msty reaches a model running on your own hardware.

## Prerequisites

> [card] [Connector paired](https://docs.tokios.com/setup/connector-install.md)
>
> Install and pair `tokios-connector` next to the model you want Msty to reach.

> [card] [Model registered](https://docs.tokios.com/setup/register-model.md)
>
> Register a deployment (public name) for that model.

> [card] [API key created](https://docs.tokios.com/setup/api-keys.md)
>
> Create an `sk-tok-…` key, optionally scoped to that deployment.

> [card] [Supported backends](https://docs.tokios.com/setup/supported-backends.md)
>
> Confirm your local backend (Ollama, llama.cpp, vLLM, LM Studio) is running.

## Add Tokios as a remote model provider

**1. Open remote model providers**

In Msty, open the model providers area and choose to add a **Remote Model Provider**. The exact label and location vary between Msty and Msty Studio versions — check yours.

**2. Choose OpenAI Compatible**

Select **OpenAI Compatible** as the provider type.

**3. Set the endpoint and key**

Fill in the provider fields:

```text theme={"theme":{"light":"github-light","dark":"css-variables"}}
API Endpoint: https://api.tokios.com/v1
API Key: sk-tok-YOUR_KEY
```

The **API Endpoint** should end in `/v1`.

**4. Fetch or add your deployment**

Click **Fetch Models**. Because Tokios implements `GET /v1/models`, your registered deployments (for example `gemma-tunnel`) populate automatically. If a provider doesn't auto-return models, add the deployment name manually. Then click **Add** to save the provider.

> [!NOTE]
>
> Replace `gemma-tunnel` with the deployment name you registered, and `sk-tok-YOUR_KEY` with your own key. The model name Msty sends is your public deployment name — not Ollama's, llama.cpp's, vLLM's, or LM Studio's local model id.

## Desktop app, model elsewhere

Msty runs on your desktop; the model you want can live on another machine entirely. The connector next to that model dials out to Tokios, and Msty calls `https://api.tokios.com/v1` with your `sk-tok-…` key — no inbound ports, no VPN. Msty's multi-model chats then work across your Tokios deployment and any other providers you've added.

## Troubleshooting

> [accordion] 401 error
>
> The API key Msty sent is missing, malformed, or has been revoked. Confirm you pasted the full `sk-tok-…` key with no extra whitespace, and check its status on the [Keys](https://tokios.com/console/keys) tab.

> [accordion] Fetch Models returns nothing or a 404
>
> The endpoint or key scope is off. Confirm the **API Endpoint** is `https://api.tokios.com/v1`, that you've registered a deployment on the [Models](https://tokios.com/console/models) tab, and that your key's scope includes it.

> [accordion] 503 error
>
> The connector for that deployment is offline or at its concurrency cap. Check the [Connectors](https://tokios.com/console/connectors) tab — the connector needs to show as **Online**, and the machine running it needs to still be up and reachable.

## Next steps

> [card] [Compatible clients](https://docs.tokios.com/guides/compatible-clients.md)
>
> See base URL and key setup for other OpenAI- and Anthropic-compatible clients.

> [card] [API keys](https://docs.tokios.com/setup/api-keys.md)
>
> Create, scope, and rotate `sk-tok-…` keys for teammates and agents.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.