エフェクト生成 V1

目的

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

メソッドとパス

POST /public/v1/generate/effect/v1

認証

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

必須ヘッダー:

Authorization: Bearer {your_api_key}

リクエストフィールド

フィールド名	タイプ	必須	説明
description	string	はい	生成するエフェクトのテキスト説明
resolution	string	はい	出力解像度。可能な値: `1K`, `2K`, `4K`
image	file	いいえ	生成するエフェクトを導くための任意の参照画像

レスポンス

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

{
  "job_id": "uuid-string"
}

フィールド	タイプ	説明
job_id	string	作成されたジョブの一意識別子。ジョブ状態の取得で結果を照会します

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

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

非同期ジョブ動作

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

ポーリング方法:

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

状態フロー: Pending → Succeed または Failed

リクエスト例

cURL (画像なし):

curl -X POST "https://api.aetherforgeai.com/public/v1/generate/effect/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "description=apply a glowing fantasy aura" \
-F "resolution=1K"

cURL (画像あり):

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

目的​

メソッドとパス​

認証​

リクエストフィールド​

レスポンス​

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

非同期ジョブ動作​

リクエスト例​

目的