Imgix APIs生成 API概要

Generations API

Generations APIは、/v1/generations/配下のRESTfulエンドポイント群で、静止画からの動画生成やアクセシビリティのための代替テキスト生成など、画像に対するAIを活用した操作を提供します。

これらの操作は、レンダリングURLパラメータではなくRESTエンドポイントとして公開されているため、URLに収まりきらない長時間実行される処理や大きなプロンプト入力を扱うことができます。

操作

操作エンドポイントメソッド方式
動画生成/v1/generations/videoPOST非同期
代替テキスト生成/v1/generations/alt-textGET同期

同期と非同期

  • 同期操作(代替テキスト生成など)は、結果をレスポンスで直接返します。
  • 非同期操作(動画生成など)はジョブを返し、readyまたはerroredになるまでポーリングします。

認証

Generations APIへのすべての呼び出しには、任意の権限(請求、アセットマネージャー読み取りなど)を持つAPIキーが必要です。キーを作成するには、ダッシュボードのAPIキービューに移動してください。

ソース機能とクレジット

生成操作には、対応するAI機能がソースで有効になっている必要があり、ほとんどの操作は アカウントのAIクレジットに対して計上されます。具体的な機能やエラーレスポンスについては、 各操作のページを参照してください。