API 導入ガイド
モデルをワークフローに組み込む前に、接続先と設定を確認しましょう。
クライアントを選ぶ
コンソール入口です。API Base URL は実際の案内からコピーし、Web 管理画面の URL と区別してください。
導入前の準備
API サービスの購入後、提供時の案内に従って次の情報を確認してください。商品ページに別途記載がない限り、Web 版のメンバーシップに API 利用枠は含まれません。
| 設定項目 | 用途 |
|---|---|
| エンドポイント(Base URL) | サービス提供時に案内される接続先。本サイトの URL とは異なります |
| API キー | 購入した API サービスへのアクセスに使用 |
| モデル ID | リクエストで指定する実際のモデル名 |
| プロトコルとパス | OpenAI 互換 API または Claude 用 API の仕様を確認 |
| 料金と上限 | 利用枠、レート制限、コンテキスト範囲、課金ルールを確認 |
開発ツールへの設定
ツールのモデルサービス設定に、案内されたエンドポイント、キー、モデル ID を入力します。まず機密情報を含まない簡単なリクエストで接続を確認してから、日常のワークフローで使い始めてください。
以下は環境変数の設定方法を示す例です。サンプル値は、実際に提供された情報に置き換えてください。 このままでは API を呼び出せません。
export SUPAKOOK_BASE_URL="提供されたエンドポイントに置き換える"
export SUPAKOOK_API_KEY="自分の API キーに置き換える"
export SUPAKOOK_MODEL="提供されたモデル ID に置き換える"
Base URL にバージョンを示すパスを含めるかどうかは、ツールによって異なります。利用するツールとサービス提供時の案内を確認してください。キーを Web のフロントエンド、公開リポジトリ、スクリーンショットに含めないでください。
リクエストの互換性と安定性
本サービスは、公式 API のリクエストフィールドへの対応と、バックエンド容量の冗長化を目指しています。フィールド、ツール呼び出し、ストリーミング出力、モデルバージョンの対応範囲は、購入した API の説明をご確認ください。
容量の冗長化によって、すべての中断を防げるわけではありません。ネットワーク、公式サービスの稼働状況、レート制限、アカウントの状態は、個々のリクエストに影響します。本番のワークフローでは、適切なタイムアウトと回数を制限した再試行を設定し、失敗時にエラーを確認できるようにしてください。
よくあるエラーの対処
- 401 / 403: キーが正しく有効か、対象サービスの利用権限があるかを確認してください。キー全体を他者に送信しないでください。
- 404: エンドポイントのパスとモデル ID を確認し、開発ツールがバージョンのパスを重複して追加していないかを確認してください。
- 429: 残高、利用枠、レート制限を確認し、同時実行数を減らして、サービスの案内に従って再試行してください。
- 5xx / タイムアウト: 発生日時、リクエスト ID(ある場合)、機密情報を除いたエラー内容を記録してください。無制限の再試行は避けてください。
サポートが必要な場合は、購入時の窓口に、商品名、ツールのバージョン、機密情報を除いた再現手順をお送りください。