API キーから本番リクエストまで。

01 / START

クイックスタート

1. コンソールで API キーを作成します。
2. 公開モデルカタログからモデル ID をコピーします。
3. キーをサーバー側の環境変数に保存し、最初のリクエストを送信します。

02 / AUTH

認証と Base URL

保護されたエンドポイントは Bearer Token を使います。API キーをブラウザーコード、公開リポジトリ、ログ、スクリーンショットに保存しないでください。

03 / CALL

3つの呼び出し方法

export TOKEN_BOAT_API_KEY="your_api_key"
export MODEL_ID="choose_from_the_model_catalog"

curl https://tokenboat.com/v1/chat/completions \
  -H "Authorization: Bearer $TOKEN_BOAT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "'"$MODEL_ID"'",
    "messages": [{"role": "user", "content": "Hello from Token Boat"}]
  }'

from openai import OpenAI
import os

client = OpenAI(
    api_key=os.environ["TOKEN_BOAT_API_KEY"],
    base_url="https://tokenboat.com/v1",
)

response = client.chat.completions.create(
    model=os.environ["MODEL_ID"],
    messages=[{"role": "user", "content": "Hello from Token Boat"}],
)
print(response.choices[0].message.content)

import OpenAI from "openai";

const client = new OpenAI({
  apiKey: process.env.TOKEN_BOAT_API_KEY,
  baseURL: "https://tokenboat.com/v1",
});

const response = await client.chat.completions.create({
  model: process.env.MODEL_ID,
  messages: [{ role: "user", content: "Hello from Token Boat" }],
});
console.log(response.choices[0].message.content);

04 / STREAM

ストリーミング

ストリーミング対応モデルでは stream: true を設定し、Server-Sent Events を順次処理します。切断と不完全な最終チャンクを処理できるようにしてください。

const stream = await client.chat.completions.create({
  model: process.env.MODEL_ID,
  messages: [{ role: "user", content: "Stream a short answer" }],
  stream: true,
});

for await (const chunk of stream) {
  process.stdout.write(chunk.choices[0]?.delta?.content ?? "");
}

05 / RECOVER

エラーと再試行

エラー応答には HTTP ステータスとメッセージが含まれます。リクエスト時刻、エンドポイント、モデル ID、ステータスを記録し、完全なキーや機密プロンプトは記録しないでください。

06 / LIMITS

レート制限

RPM、TPM、同時実行数はアカウント、モデル、現在のポリシーにより異なるため、変動する数値は固定表示しません。429 では応答ヘッダーとアカウントコンソールを確認してください。

• 同時実行数を制限し、クライアントタイムアウトを設定します。
• 429 と一時的な 5xx にはジッター付き指数バックオフを使います。
• 生成タスクを無条件に再送せず、先にタスク状態を確認します。
• 本番負荷で上限引き上げが必要な場合はサポートセンターへ連絡します。

07 / REFERENCE

主要エンドポイント

主要な公開エンドポイントです。各モデルが実際に対応する形式はモデル詳細で確認してください。

API 契約の参照元：docs/openapi/relay.json