> ## 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 big-AGI with your own local model

> Add Tokios as a custom OpenAI-compatible endpoint in big-AGI so this multi-model front-end can reach a model running on your own hardware.

big-AGI is a feature-rich, multi-provider AI front-end that supports adding **up to five custom OpenAI-compatible endpoints**. Point one at `https://api.tokios.com/v1` with your `sk-tok-…` key, and big-AGI talks to a model running on your own hardware alongside any other providers you've configured.

## Prerequisites

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

**1. Open the models configuration**

Open big-AGI's **Models** settings and choose to add a source. Select the **OpenAI-compatible** vendor (the option for a custom OpenAI-style endpoint). The exact menu path and labels vary by big-AGI version — confirm against the version you're running.

**2. Set the API host and key**

Enter the Tokios endpoint and your key:

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

Include `/v1` in the host.

**3. Load your deployment**

big-AGI auto-detects models from the endpoint. Because Tokios implements `GET /v1/models`, your registered deployments (for example `gemma-tunnel`) appear for selection. If a model isn't listed, confirm your key is scoped to that deployment on the [Keys](https://tokios.com/console/keys) tab.

> [!NOTE]
>
> For a self-hosted big-AGI, you can set the same values with environment variables — `OPENAI_API_HOST=https://api.tokios.com/v1` and `OPENAI_API_KEY=sk-tok-YOUR_KEY`. Never commit a real key into version control or a shared config.

## One front-end, models from anywhere

big-AGI is built to talk to many providers at once. Adding Tokios as one of its custom OpenAI-compatible endpoints slots your own local model in next to everything else — the connector next to that model dials out to Tokios, and big-AGI reaches it at `https://api.tokios.com/v1` without an inbound port or VPN.

## Troubleshooting

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

> [accordion] The model list is empty
>
> big-AGI populates models from `GET /v1/models`. Make sure you've registered at least one deployment on the [Models](https://tokios.com/console/models) tab and that your key's scope includes it. Confirm the host is `https://api.tokios.com/v1`.

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