> ## 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 Jan with a model on your own hardware

> Add Tokios as a custom OpenAI-compatible provider in Jan so the app can reach a bigger model running on your own desktop or server.

Jan is a local-first desktop app that normally runs models on-device, but it can also add a **custom / remote OpenAI-compatible provider**. Point that provider at `https://api.tokios.com/v1`, paste an `sk-tok-…` key, and use your Tokios **deployment** name as the model — Jan then talks to a model running on a different machine instead of only the models installed locally.

## Prerequisites

> [card] [Connector paired](https://docs.tokios.com/setup/connector-install.md)
>
> Install and pair `tokios-connector` next to the model you want Jan 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 model provider in Jan

**1. Open Jan's model provider settings**

In Jan, open **Settings → Model Providers**. The exact menu path and labels may differ slightly by Jan version — confirm against the version you're running.

**2. Add an OpenAI-compatible provider**

Add a custom provider using Jan's **OpenAI-compatible** option.

**3. Set the base URL and API key**

Enter the Tokios endpoint and your key:

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

Save the provider.

**4. Add your deployment as a model**

Add a model entry using the **public deployment name** you registered in the [Models](https://tokios.com/console/models) tab — for example, `gemma-tunnel`. This is the value Jan sends in the `model` field; it is not Ollama's, llama.cpp's, vLLM's, or LM Studio's local model id.

> [!NOTE]
>
> Replace `gemma-tunnel` with the deployment name you registered, and `sk-tok-YOUR_KEY` with your own key. Never commit either into a shared config file.

## Laptop UI, desktop model

The common shape this solves: Jan is installed on a laptop, but the model you actually want to use — bigger than anything that laptop can run — lives on a desktop or server elsewhere on your network or in another location entirely.

Instead of limiting yourself to Jan's on-device models, or trying to expose your desktop's backend directly to the laptop, the connector on the desktop dials out to Tokios, and Jan on the laptop calls `https://api.tokios.com/v1` with your `sk-tok-…` key. You get Jan's local-first UI with a model that isn't local to the machine you're typing on.

## Troubleshooting

> [accordion] 401 error
>
> The API key Jan 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] 404 error
>
> The model value Jan sent doesn't match a registered deployment. Confirm the model name in Jan exactly matches the public name on the [Models](https://tokios.com/console/models) tab — not your Ollama/llama.cpp/vLLM/LM Studio local model id.

> [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.