API リファレンス
本番公開の前に
本番トラフィックの前にこのチェックリストを使ってください。キーのセキュリティ、再試行、非同期タスクの永続性、可観測性、課金を 1 つのリリース判定にまとめています。
#本番チェックリスト
セキュリティ
- API キーは信頼できるサーバーに保管し、永続的なキーをブラウザやモバイルアプリのバイナリに含めないでください。
- プロジェクトごとにスコープを絞ったキーを 1 つ使い、モデル、IP、RPM、RPD、利用枠の上限を設定します。
- モデル統合のコードを変更せずにキーをローテーションします。
信頼性
- すべてのリクエストに接続タイムアウトと応答タイムアウトを設定します。
- Retry-After に従い、ジッター付きの指数バックオフを使います。
- 課金対象の非同期送信には Idempotency-Key を使い、task_id を保存します。
可観測性
- リクエスト ID、モデル、エンドポイント、レイテンシー、HTTP ステータス、task_id をログに記録します。
- デバッグを明示的に有効にしない限り、プロンプトの内容はログに残しません。
- 顧客に見える失敗を、対応するリクエストログの行にひも付けます。
コスト管理
- 料金と対応オプションは、リアルタイムのモデルメタデータから読み取ります。
- プロジェクトの利用枠の上限を設定し、ウォレットが尽きる前にアラートを出します。
- リクエストログにある小数点以下 6 桁の最終消費額と照合します。
#リリース判定
- 1
最小限のリクエストをテスト
ワークベンチで実際のモデルとエンドポイントを実行し、生成されたリクエストをコピーします。
- 2
失敗パスをテスト
401、402、429、タイムアウト、無効なメディア、タスクの失敗終了の処理を検証します。
- 3
課金を検証
成功したリクエストを、小数点以下 6 桁の消費額とリクエスト ID に照合します。
- 4
モニタリングを有効化
エラー率、レイテンシー、停滞したタスク、Webhook の失敗、残高不足でアラートを出します。
#運用のショートカット
まだ解決しませんか？
リクエスト ID かエラーメッセージを送っていただければ、こちらで調査します。