メインコンテンツへスキップ

エフェクト生成 V2

目的

エフェクト風の結果を非同期で生成します。エフェクト生成を導くためにテキスト説明を指定でき、必要に応じて画像をアップロードできます。

メソッドとパス

POST /public/v1/generate/effect/v2

認証

認証 ページを参照してください。Bearer トークンが必要です。

必須ヘッダー:

Authorization: Bearer {your_api_key}

リクエストフィールド

フィールド名必須説明
descriptionstringはいエフェクト説明
qualitystringはい品質: standard, pro
framenumberはいフレーム数: 4, 9, 16
imagefileいいえ参照画像

レスポンス

成功レスポンス (200 OK):

{
"job_id": "uuid-string"
}
フィールド説明
job_idstring作成されたジョブの一意識別子。ジョブ状態の取得で結果を照会します

エラー / バリデーションルール

状況HTTP状態エラーメッセージ
Invalid image file400"Invalid image file"
APIキーが無効401Invalid API key

非同期ジョブ動作

このエンドポイントは非同期ジョブを作成します。リクエスト直後に job_id を返し、実際のエフェクト生成はバックグラウンドで進行します。

ポーリング方法:

  1. レスポンスで受け取った job_id を保存します
  2. GET /public/v1/job/{job_id} をポーリングして状態を確認します
  3. 状態が Succeed になったら image_urls で結果を確認します

状態フロー: PendingSucceed または Failed

リクエスト例

cURL (画像なし):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "quality=standard" \
-F "frame=4"

cURL (画像あり):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v2" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a neon cyberpunk effect" \
-F "quality=pro" \
-F "frame=16" \
-F "image=@/path/to/input.png"