エラー
一般的なオープン API エラーの形状とステータス コード。
エラー
オープン API エラーは、リクエストが API レイヤーに到達すると、JSON 応答本文を使用します。ネットワーク障害、CDN 障害、およびバイナリ応答の中断は、この正確な形式を持たない可能性があるため、クライアントは構造化 API エラーとトランスポート エラーの両方を処理する必要があります。
すべてのエンドポイントは同じベアラー認証コンテキストを使用します。
Authorization: Bearer FISHAUDIO_API_KEY{
"code": "invalid_request",
"message": "The request payload is invalid.",
"requestId": "req_xxx"
}ステータスコード
| ステータス | 意味 | 典型的なアクション |
|---|---|---|
400 | 無効なリクエスト本文、パス パラメータ、クエリ パラメータ、またはメディア URL | 再試行する前にリクエストを修正してください |
401 | API キーが見つからない、形式が間違っている、取り消されている、または無効になっています。再試行を停止し、資格情報を更新します。 | |
402 | クレジットが不十分、API クォータ、またはプロバイダーの割り当て | バッチを停止して請求状態を表示する |
404 | 認証されたアカウントのリソース ID が不明です | ローカル レコードを更新する |
409 | リソースは操作と競合する状態です | 待つか依存関係を削除する |
422 | メディアは受け入れられましたが、処理できません | 別の入力メディアを要求する |
429 | レート制限を超えました | 指数バックオフを使用して再試行 |
500 | サーバーエラー | 少数回再試行し、requestId をログに記録します。 |
リクエストのロギング
エンドポイント、HTTP メソッド、ステータス、code、requestId、および独自の内部ジョブ ID をログに記録します。プライバシー ポリシーとサポート ワークフローで明示的に許可されていない限り、ベアラー API キー、ユーザー テキスト全体、またはプライベート メディア URL をログに記録しないでください。
非同期エンドポイントの場合は、API タスク ID と内部データベース ID の両方をログに含めます。これにより、重複した作業を作成せずに再試行を調整することが可能になります。
請求とクレジット
すべてのエラーが同じ請求の意味を持つわけではありません。検証の失敗は通常、メディア作業が開始される前に発生します。タスクが受け入れられた後に処理エラーが発生する場合があります。ユーザー向けの請求に関する質問の場合は、HTTP ステータスだけからコストを推測するのではなく、タスクのステータスを新しく読み取った プロファイル と比較します。
再試行ポリシー
429 および一部の 500 応答をバックオフで再試行します。 400、401、または 402 をやみくもに再試行しないでください。これらには、リクエスト、資格情報、または請求の変更が必要です。エンドポイントの作成の場合は、後続の操作を再試行する前に、返された ID を保持します。