API リファレンス
エラーコード
TokSpan API が返す可能性のあるすべてのエラーコードの完全なリファレンス。説明とトラブルシューティング手順付きです。
HTTP ステータスコード
| コード | 意味 | 対処方法 |
|---|---|---|
| 400 | 不正なリクエスト | リクエストボディに不正な JSON 形式や必須フィールドの欠落がないか確認してください |
| 401 | 認証エラー | API キーが正しく、ダッシュボードで有効になっているか確認してください |
| 404 | 無効な URL / エンドポイントが見つかりません | API リファレンスと照合してリクエストパスを確認してください |
| 429 | レート制限 / クォータ不足 | レート制限にはジッター付き指数バックオフを実装してください。エラーがクォータや残高に言及している場合(例: insufficient_user_quota)、再試行せずダッシュボードでチャージしてください — レート制限 をご参照ください |
| 500 | 内部エラー | TokSpan 側の問題です — バックオフ付きで再試行するか、サポートにお問い合わせください |
| 502 | 不正なゲートウェイ | 上流プロバイダーのエラーです — 自動フェイルオーバーが作動する可能性があります |
| 503 | サービス利用不可 / モデルが見つかりません | 一時的な過負荷です — バックオフ付きで再試行してください。エラーにコード model_not_found が含まれる場合、モデルはこのキーでは利用できません — モデルカタログでモデル名を確認してください |
エラーレスポンス形式
エラーは、人間が読める message と識別子 type を含む error オブジェクトで返されます。TokSpan では type は通常 new_api_error で、アカウント残高エラーは code: "insufficient_user_quota" を伴います。例:
json
{
"error": {
"message": "You can access all models, but this request exceeded your account balance. Please top up at the Dashboard.",
"type": "new_api_error",
"param": null,
"code": "insufficient_user_quota"
}
}メッセージを読むことが重要です。 レート制限メッセージの 429 は退避して再試行を意味し、クォータメッセージの 429(または 400)は先にクレジットを追加することを意味します。対処法を決める前にメッセージを確認してください。ここに示したメッセージ文言は例です — 常に HTTP ステータスコードと code フィールドを基準にしてください。