LogoLogoAPI ドキュメント
LogoLogoAPI ドキュメント
ホームページ
概要認証と冪等性画像生成画像編集画像変換ジョブと待機クレジットエラーレート制限と同時実行API 変更履歴
API ドキュメント

クレジット

残高の取得と確保の仕組み

残高を取得する

GET /api/v1/credits は credits:read を必要とし、利用可能な残高(整数)だけを 返します。

curl https://sci-draw.com/api/v1/credits \
  -H 'Authorization: Bearer sd_YOUR_KEY'
{ "success": true, "data": { "balance": 125 } }

確保のライフサイクル

クレジットは、ジョブが最初に受理された時点でアトミックに確保されます。これに より、同時に届いた 2 つのリクエストが同じ残高を二重に消費することを防ぎます。 冪等なリクエストを繰り返した場合は、最初の確保がそのまま再利用されます。

  • 成功したジョブは、確保した額をちょうど一度だけ確定します。
  • 終了状態の失敗では、元の割り当てをそのまま解放します。
  • 内部で再試行が行われても、新たな確保は発生しません。
  • credits_reserved と credits_consumed はどのジョブでも参照できます。

ジョブ作成時に利用可能な残高が不足している場合、API は HTTP 402 と INSUFFICIENT_CREDITS を返し、ジョブも確保も作成されません。

ジョブと待機

非同期処理をポーリングし、サニタイズ済みの結果を読む

エラー

安定したエラーエンベロープ、コード、HTTP ステータス

目次

残高を取得する
確保のライフサイクル