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

# コーディングエージェントに Tokios をセットアップしてもらう

> Claude Code、Codex、または任意のコーディングエージェントに自動化トークンとこのページを渡します。エージェントがコネクタをペアリングし、モデルを公開し、API キーを発行し、接続経路を無人で検証します。

このページの読者は 2 種類です。最初のセクションはあなた向けで、[エージェント向けの説明](#instructions-for-the-agent) 以降はエージェントが読んで実行します。

> [!NOTE]
>
> **あなたがエージェントの場合:** このページの raw markdown をブラウザツールではなくシェルで取得してください。コマンドと JSON の構造がそのまま届きます:
>
> ```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
> curl -fsSL https://docs.tokios.com/guides/agent-setup.md
> ```
>
> その後、[エージェント向けの説明](#instructions-for-the-agent) に従ってください。このサイトのすべてのページは URL に `.md` を追加すると markdown で取得でき、サイト全体は `https://docs.tokios.com/llms-full.txt` にあります。

## 始める前に

**1. 自動化トークンを作成する**

コンソールで **[Settings](https://tokios.com/console/settings)** を開き、**Automation tokens**、**Create token** の順にクリックします。**Setup** プリセットと **1 hour** の有効期限を使用します。トークンを一度だけコピーしてください。[自動化トークン](/ja/setup/automation-tokens.md) も参照してください。

**2. モデルを配信しているマシンでエージェントを実行する**

エージェントはそのマシンでコネクタのインストールコマンドを実行する必要があります。Ollama、LM Studio、llama.cpp、または vLLM がすでにデフォルトポートで実行中であることを確認してください。

**3. トークンをシェル変数に設定する**

変数を設定してから、同じシェルからエージェントを起動し、シークレットが会話に入らないようにします。

**Windows PowerShell**

```powershell theme={"theme":{"light":"github-light","dark":"css-variables"}}
$env:TOKIOS_CONSOLE="https://tokios.com"
$env:TOKIOS_TOKEN="at-tok-YOUR_TOKEN"
claude
```

**Windows CMD**

```cmd theme={"theme":{"light":"github-light","dark":"css-variables"}}
set TOKIOS_CONSOLE=https://tokios.com
set TOKIOS_TOKEN=at-tok-YOUR_TOKEN
claude
```

**macOS & Linux**

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
export TOKIOS_CONSOLE=https://tokios.com
export TOKIOS_TOKEN=at-tok-YOUR_TOKEN
claude
```

**4. エージェントに 1 つのメッセージを送る**

```text theme={"theme":{"light":"github-light","dark":"css-variables"}}
Read https://docs.tokios.com/guides/agent-setup and follow it. The console base URL is in the TOKIOS_CONSOLE variable and the automation token is in TOKIOS_TOKEN. Never print the token. My model server is Ollama on this machine. When you are done, give me the final report described on that page.
```

お使いのバックエンドが Ollama 以外の場合は、メッセージ内の `Ollama` をそのバックエンド名に置き換えてください。Codex でも同じメッセージが機能します。エージェントにサービスをインストールさせたい場合は、「Make the connector start at boot.」を追加してください。追加しない場合、エージェントはコネクタが再起動後に生存しないことを報告するのみです。

実行中は **Connectors** タブを監視してください。保留中のデバイスが表示され、その後発表されたモデルとともにアクティブになります。エージェントが作成した行には **via token** バッジが表示されます。エージェントが報告したら、**Settings** でトークンを取り消してください。

> [!NOTE]
>
> コーディングエージェントはダウンロードしたスクリプトをシェルにパイプすることを拒否するため、エージェントはインストールのワンライナーを使用しません。エージェントはゲートウェイを通じてコネクタバイナリをダウンロードし、チェックサムを検証し、自分で起動します。エージェントがブロックされたインストーラコマンドについて尋ねて停止した場合は、このページを指し示してください。

## エージェント向けの説明

Tokios ワークスペースを無人でセットアップします。このマシンでコネクタをペアリングし、ローカルモデルを公開し、コーディングクライアント用の API キーを発行し、パス全体を検証します。ワークスペースの管理 API と 1 つの資格情報（自動化トークン）を通じて操作します。

### 持っているもの

* `TOKIOS_CONSOLE`: コンソールのベース URL。通常は `https://tokios.com`。以下のすべての呼び出しは `TOKIOS_CONSOLE` + `/account/...` です。
* `TOKIOS_TOKEN`: 自動化トークン。`at-tok-…` です。すべての呼び出しで `Authorization: Bearer <token>` として送信します。Setup スコープを持ち、まもなく有効期限が切れます。
* このマシンのループバックですでに実行中のモデルサーバ。Ollama はポート 11434、LM Studio は 1234、llama.cpp は 8080、vLLM は 8000 です。コネクタはこれらを自動的に検出します。

### ルール

1. **トークンをどこにも表示、ログ出力、書き込みしないでください。** 例外は `Authorization` ヘッダだけです。シェル変数から毎回読み取ります。bash では `$TOKIOS_TOKEN`、PowerShell では `$env:TOKIOS_TOKEN`、cmd では `%TOKIOS_TOKEN%` です。ステップ 5 で発行する API キーは異なります。最終レポートで人間に渡してください。
2. トークンは `TOKIOS_CONSOLE/account/*` でのみ機能します。`/admin`、`/auth`、`/v1`、`/portal` では試さないでください。
3. **作成する前に一覧を確認してください。** 同じ名前の保留中のコネクタと同じ公開名のデプロイメントを再利用してください。リトライが失敗したからといって追加の API キーを作成しないでください。作成はプレーンな POST であり、冪等ではありません。
4. エラーは JSON です: `{"error":{"message":"…","type":"…","scope":"…"}}`。
   * `401`: トークンが無効、有効期限切れ、または取り消し済み。停止して報告。
   * `403`（`scope` 付き）: トークンにそのスコープがない。停止してどのスコープが不足しているか報告。
   * `403` "only available from the console": その操作はサインインした人間専用。回避しないでください。
   * `409`（承認時）: コネクタ行を再読し、ステップ 3 の説明に従って再試行。
   * `429`: 60 秒待機してから再試行。
5. パスワードの変更、キーの開示や共有、リクエストログの変更、他のトークンの作成は行わないでください。これらはできませんし、試みてもいけません。
6. 各ステップの結果を報告してください。ステップが失敗またはスキップされた場合は、率直にそう述べてください。

例は bash を使用しています。Windows cmd では URL と JSON をダブルクォートで囲み、内部のクォートをエスケープします。例: `-d "{\"name\":\"gpu-box\"}"`。

### ステップ 1: ペアリングを開始

まず既存のコネクタを一覧表示します:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s "$TOKIOS_CONSOLE/account/connectors" -H "Authorization: Bearer $TOKIOS_TOKEN"
```

意図した名前の行にすでに `"status":"pending_pair"` がある場合は、新しいペアリングコードで再利用します:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/connectors/CONNECTOR_ID/claim-code" -H "Authorization: Bearer $TOKIOS_TOKEN"
```

ない場合は作成します:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/connectors" \
  -H "Authorization: Bearer $TOKIOS_TOKEN" -H "Content-Type: application/json" \
  -d '{"name":"gpu-box"}'
```

どちらも以下を返します:

```json theme={"theme":{"light":"github-light","dark":"css-variables"}}
{
  "connector_id": "con_…",
  "claim_code": "TKS-XXXX-XXXX",
  "claim_code_expires_at": "2026-…",
  "server_url": "wss://…/connector/connect",
  "install_oneliner": {
    "macos": "curl -fsSL https://tokios.com/downloads/install/macos | sh -s -- --code TKS-XXXX-XXXX",
    "linux": "curl -fsSL https://tokios.com/downloads/install/linux | sh -s -- --code TKS-XXXX-XXXX",
    "windows": "irm https://tokios.com/downloads/install/windows | iex; tokios-install -Code 'TKS-XXXX-XXXX'"
  }
}
```

ペアリングコードは 15 分間有効です。`claim_code` と `server_url` を保持し、`install_oneliner` は無視してください（スクリプトをシェルにパイプするため、行ってはいけません — ステップ 2 を参照）。このレスポンスにコネクタトークンはありません。これからもありません。コネクタは承認後にトンネルを通じて自身のクレデンシャルを受け取ります。

### ステップ 2: このマシンにコネクタをインストールして切り離し状態で起動

エージェントの安全ルールでは、ダウンロードしたスクリプトをシェルにパイプすること（`curl … | sh`、`irm … | iex`）が拒否されます。スクリプトを保存してから実行しても、形を変えただけで同じことです。どちらも行わず、人間に承認を求めないでください。
パス A を使用してください。ダウンロードしたスクリプトは一切実行しません。コネクタバイナリ自体をゲートウェイのリダイレクトを通じてダウンロードし、リリースの `SHA256SUMS` に対して検証し、ステップ 1 のペアリングコードと `server_url` を使ってバックグラウンドで起動します。

**パス A（こちらを使用）: バイナリをダウンロードし、検証してから実行します。**

このマシン用のアセットを選択します: `linux/x64` → `tokios-connector-linux-x64`、`linux/arm64` →
`tokios-connector-linux-arm64`、`macos/arm64` → `tokios-connector-osx-arm64`、`windows/x64` →
`tokios-connector-win-x64.exe`、`windows/arm64` → `tokios-connector-win-arm64.exe`。

Linux と macOS（`linux/x64` で表示。macOS では `shasum -a 256` を `sha256sum` の代わりに使用）:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
mkdir -p ~/.tokios/connector && cd ~/.tokios/connector
curl -fsSL -o tokios-connector "$TOKIOS_CONSOLE/downloads/connector/linux/x64"
curl -fsSL -o SHA256SUMS https://github.com/tokiosAI/tokios-connector/releases/latest/download/SHA256SUMS
expected=$(grep -E '\*?tokios-connector-linux-x64$' SHA256SUMS | awk '{print $1}')
actual=$(sha256sum tokios-connector | awk '{print $1}')
[ -n "$expected" ] && [ "$expected" = "$actual" ] || { echo "checksum mismatch"; exit 1; }
chmod +x tokios-connector
nohup ./tokios-connector TKS-XXXX-XXXX --Connector:ServerUrl "SERVER_URL" > tokios-connector-stdout.log 2>&1 < /dev/null &
echo $! > tokios-connector.pid
```

Windows、PowerShell（`windows/x64` で表示）:

```powershell theme={"theme":{"light":"github-light","dark":"css-variables"}}
$dir = Join-Path $env:LOCALAPPDATA 'Tokios\connector'
New-Item -ItemType Directory -Force -Path $dir | Out-Null
Set-Location $dir
Invoke-WebRequest "$env:TOKIOS_CONSOLE/downloads/connector/windows/x64" -OutFile tokios-connector.exe
Invoke-WebRequest https://github.com/tokiosAI/tokios-connector/releases/latest/download/SHA256SUMS -OutFile SHA256SUMS
$expected = (((Get-Content SHA256SUMS) -match 'tokios-connector-win-x64\.exe$') -split '\s+')[0].ToLower()
$actual = (Get-FileHash tokios-connector.exe -Algorithm SHA256).Hash.ToLower()
if (-not $expected -or $expected -ne $actual) { throw "checksum mismatch" }
$p = Start-Process -FilePath .\tokios-connector.exe -ArgumentList 'TKS-XXXX-XXXX','--Connector:ServerUrl','SERVER_URL' -WorkingDirectory $dir -WindowStyle Hidden -RedirectStandardOutput tokios-connector-stdout.log -RedirectStandardError tokios-connector-stderr.log -PassThru
Set-Content tokios-connector.pid $p.Id
```

以下を置き換えます: `TKS-XXXX-XXXX` はステップ 1 の `claim_code` に、`SERVER_URL` は `server_url` に。コネクタは接続し、コードを提示し、承認を待ち、バイナリの隣に自身の設定を書き込みます。マシンにすでに `tokios-connector` がインストールされている場合は、ダウンロードをスキップしてそのバイナリを同じ方法で実行します。

**パス B（人間がインストーラを求めた場合のみ）:** インストーラは同じダウンロードとチェックサムステップを実行し、`--detach` フラグを追加します。人間が貼り付けるためのものです。使用するよう求められた場合は、ファイルにダウンロードして実行する前に読み、レポートにそう記載してください。絶対にパイプしないでください。

コネクタの出力は `tokios-connector-stdout.log` に、pid は `tokios-connector.pid` に、上のディレクトリに保存されます。後で `kill $(cat tokios-connector.pid)` または `Stop-Process -Id (Get-Content tokios-connector.pid)` で停止します。

**永続化。** 切り離し状態のプロセスは再起動後に生存しません。人間のメッセージでコネクタを起動時に自動起動するよう求められない限り、サービスをインストールしないでください。そうでない場合は最終レポートでそう述べ、インストールを提案してください。求められた場合: まずステップ 3 から 6 を完了し、切り離し状態のプロセスを停止し（`kill $(cat tokios-connector.pid)`。コネクタはディレクトリごとに 1 インスタンスのみ許可）、このプラットフォームの [起動時にコネクタを実行する](/ja/setup/connector-install.md#run-the-connector-at-boot) に従ってください。Linux では systemd ユーザユニットで、`ExecStart` は `%h/.tokios/connector/tokios-connector --config %h/.tokios/connector/tokios-connector.json`、`systemctl --user enable --now tokios-connector` で有効化し、ログインなしで起動するために `loginctl enable-linger "$USER"` を追加します。ペアリングは `tokios-connector.json` に保存されるため、サービスは新しいペアリングコードなしで再接続します。

### ステップ 3: デバイスを待機してから承認

3 秒ごとに最大 2 分間ポーリングします:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s "$TOKIOS_CONSOLE/account/connectors" -H "Authorization: Bearer $TOKIOS_TOKEN"
```

まず `connector_id` を探します。行に `"claimPending": true` が表示されている場合、`"sessionId": "sess_…"` と `"machineName"` も含まれます。マシン名がこのマシンであることを確認し、その正確なセッション ID で承認します:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/connectors/CONNECTOR_ID/approve" \
  -H "Authorization: Bearer $TOKIOS_TOKEN" -H "Content-Type: application/json" \
  -d '{"session_id":"sess_…"}'
```

成功は `{"status":"approved"}` です。

ステータスが `409` の場合、デバイスが新しいセッション ID で再接続した、まだ接続されていない、またはペアリングコードの有効期限が切れています。行を再読してください。コードの有効期限が切れている場合は、ステップ 1 と同様に新しいものをリクエストし、コネクタをそれで再起動してください。それ以外の場合は、現在の `sessionId` で再度承認してください。

行に `"status":"active"`、`"online":true`、空でない `"announcedModels"` が表示されるまでポーリングを続けます。最大 60 秒かかります。コネクタは承認後にローカルモデルを検出します。`announcedModels` が空のままの場合、検出されたループバックポートでモデルサーバが実行されていません。それを報告して停止してください。

### ステップ 4: モデルを公開

ワークスペースのポリシーを確認します:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s "$TOKIOS_CONSOLE/account/auto-publish" -H "Authorization: Bearer $TOKIOS_TOKEN"
```

* レスポンスが `{"auto_publish": true}` の場合、発表されたすべてのモデルが自動的に公開されます。`GET $TOKIOS_CONSOLE/account/models` をポーリングし、発表された名前が `id` 値として表示されるのを確認します。

  報告時にその意味を正確に伝えてください。「公開済み」とは、モデルがこのワークスペースにデプロイメントを持つことを意味します。モデルスコープがそのモデルを含む、このワークスペースの API キーを持っていれば誰でも API ホストで呼び出すことができ、それ以外の人は呼び出せません。キーなしでアクセス可能なものはありません。これはコネクタが承認後にモデルを発表した瞬間、数秒後に発生し、公開名はアップストリームモデル ID（例: `gemma4:e4b`）です。自動公開は、削除したモデルをコネクタが再度発表した場合も再公開します。そのため、人間が検出されたモデルの一部のみを公開したい場合は、他のモデルを `POST $TOKIOS_CONSOLE/account/deployments/DEPLOYMENT_ID/disable` で一時停止し、自動公開がオンであることを伝えてください。一時停止したモデルは一時停止したままです。削除はしないでください。削除には `models:reroute` スコープが必要ですが、Setup プリセットには含まれていません。また、自動公開は削除されたモデルを再び公開します。
* これが `false` を返す場合、まず `GET $TOKIOS_CONSOLE/account/deployments` を一覧表示し、呼び出し可能にすべきモデルごとに 1 つのデプロイメントを作成します。

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/deployments" \
  -H "Authorization: Bearer $TOKIOS_TOKEN" -H "Content-Type: application/json" \
  -d '{"public_name":"gemma4:e4b","upstream_model":"gemma4:e4b","connector_id":"con_…"}'
```

`public_name` はクライアントが `model` フィールドで送信するものです。`upstream_model` は `announcedModels` のいずれか 1 つである必要があります。`409` は名前が既に存在することを意味します。そのままにしてください。

### ステップ 5: API キーを発行

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/keys" \
  -H "Authorization: Bearer $TOKIOS_TOKEN" -H "Content-Type: application/json" \
  -d '{"display_name":"laptop 2026-10-16","model_patterns":["gemma4:e4b"]}'
```

レスポンス: `{"id":"key_…","secret":"sk-tok-…","retrievable":true}`。`secret` は一度だけ表示されます。レポート用に保持してください。`model_patterns` は公開したモデルに制限してください。人間がすべてのモデルを要求した場合のみ省略します。

### ステップ 6: 検証

ヘルスチェックを実行します。トンネル経由の 1 トークンのピングです:

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "$TOKIOS_CONSOLE/account/models/healthcheck" \
  -H "Authorization: Bearer $TOKIOS_TOKEN" -H "Content-Type: application/json" \
  -d '{"model":"gemma4:e4b"}'
```

レスポンスで `"status":"ok"` と `latency_ms` を確認します。次に、トークンではなく **API キー** で実際の呼び出しを 1 回行います。クライアントのベース URL は `https://api.tokios.com` です。`GET $TOKIOS_CONSOLE/account/connection` で確認でき、`base_url` を返します。

```bash theme={"theme":{"light":"github-light","dark":"css-variables"}}
curl -s -X POST "https://api.tokios.com/v1/chat/completions" \
  -H "Authorization: Bearer sk-tok-…" -H "Content-Type: application/json" \
  -d '{"model":"gemma4:e4b","messages":[{"role":"user","content":"Say hello in five words."}],"max_tokens":32}'
```

### ステップ 7: 最終レポート

人間に以下を渡します:

* コネクタ: 名前、ID、ステータス、マシン名。
* 公開したモデル: 公開名と、自動公開が作成したかあなたが作成したか。これらを呼び出せるのはワークスペースの API キーの保持者だけであり、一般には公開されていないことを人間に念押ししてください。
* コネクタが再起動後に生存するか: サービスをインストールしていない限り「いいえ、切り離し状態で実行されています」。インストールした場合はどれかを伝えてください。
* API キー: その ID **および `sk-tok-` シークレット**。これが渡す 1 つの秘密情報です。
* クライアント設定。`GET $TOKIOS_CONSOLE/account/connection` から:
  * Claude Code: `ANTHROPIC_BASE_URL=<base_url>`、`ANTHROPIC_API_KEY=<sk-tok-…>`、および `--model` で渡すモデル名。
  * Codex: `OPENAI_BASE_URL=<base_url>/v1`、`wire_api=responses`、`disable_response_storage=true`。
* 検証結果: ヘルスチェックのステータスとチャットの返信。
* スキップまたは実行できなかったものと、その理由。

> **[自動化トークン](/ja/setup/automation-tokens.md)**
>
> スコープ、プリセット、有効期限、トークンの取り消しや再生成の方法。

> **[Claude Code](/ja/guides/claude-code.md)**
>
> エージェントが作成したキーとモデルを Claude Code に設定します。


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