クレジット残高を取得
GET /credits/balanceの認証、フィールド、応答、エラー、安全な運用をソースから生成した参考資料です。
このページの目次
操作
GET /credits/balance
operationId: credits_balance_v1_credits_balance_get
WebとAPIで共有する現在の利用可能クレジットを取得します。認証済みアカウントはAPIを利用できますが、有料生成には十分な残高が必要です。支出前に意図した操作を見積もってください。
認証と副作用
サーバー側のBearer APIキーを使います。必要な権限：animations:read
有料生成は始めません。ほかの状態変更は上記を確認してください。
パラメータ
パス、クエリ、操作固有のヘッダーパラメータはありません。
応答
| HTTP | 本文 | 説明 |
|---|---|---|
200 |
CreditsBalanceResponse | Successful public response. Example values are illustrative. |
400 |
APIErrorEnvelope | Invalid input; correct the request before retrying. |
401 |
APIErrorEnvelope | Missing, expired, or revoked API key. |
403 |
APIErrorEnvelope | Account eligibility, account status, or key scope does not allow this operation. |
404 |
APIErrorEnvelope | Resource is unavailable, not owned, or its signature is invalid/expired. |
429 |
APIErrorEnvelope | Account-wide rate or queue limit; wait for Retry-After. |
500 |
APIErrorEnvelope | Internal failure; preserve the task/key and retry only when marked retryable. |
503 |
APIErrorEnvelope | Service/provider unavailable; retry only when error.retryable is true. |
応答ヘッダー
| HTTP | ヘッダー | 型 | 説明 |
|---|---|---|---|
429 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
503 |
Retry-After |
integer |
Suggested wait in seconds; respect the server value and an overall deadline. |
応答例
{
"available": 1,
"object": "credit_balance"
}
関連ガイド
この記事は役に立ちましたか？
検索語句、コード、自由記述は収集しません。この設定はドキュメントの操作イベントのみを制御します。 プライバシーポリシー