バリエーション装備
Purpose
アイテムシートのアイテムをキャラクターベース画像に装備させ、装備後のバリエーションを生成します。ウェブアプリの「バリエーション装備」ページと同じ機能です。
クレジット消費: 5
Method and Path
POST /public/v1/image-tune/equip-variation
Authentication
認証ページを参照してください。Bearerトークンが必要です。
必須ヘッダー:
Authorization: Bearer {your_api_key}
Request Fields
リクエストは multipart/form-data で送信します。
| フィールド名 | タイプ | 必須 | 説明 |
|---|---|---|---|
| character_image | file | はい | キャラクターベース画像 (PNG または JPEG) |
| item_sheet_image | file | はい | アイテムシート画像 (PNG または JPEG) |
| prompt | string | はい | アイテムをどのように装備させるかを説明するプロンプト。空白は削除され、プロンプトは空にできません |
Response
成功レスポンス (200 OK):
{
"job_id": "uuid-string"
}
| フィールド | タイプ | 説明 |
|---|---|---|
| job_id | string | 作成されたジョブの一意識別子。Get Job Statusで結果を照会し ます |
Error / Validation Rules
| 状況 | HTTP状態 | エラーメッセージ |
|---|---|---|
| いずれかの画像が有効な PNG または JPEG ファイルでない | 400 | "Invalid image file" |
| promptが空 | 400 | "prompt must not be empty" |
| 無効なAPIキー | 401 | "Invalid API key" |
| フィールド欠落 | 422 | Validation error |
両方の画像はアップロード前に検証されるため、失敗したリクエストが部分的なアップロードを残すことはありません。
Async Job Behavior
このエンドポイントは非同期ジョブを作成します。リクエスト即座にjob_idを返し、生成はバックグラウンドで進行します。
ポーリング方法:
- レスポンスで受け取った
job_idを保存します GET /public/v1/job/{job_id}をポーリングして状態を確認します- 状態が
Succeedになるとimage_urlsで結果を確認します
状態フロー: Pending → Succeed または Failed
Example Request
cURL:
curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/equip-variation" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "character_image=@/path/to/character.png" \
-F "item_sheet_image=@/path/to/item_sheet.png" \
-F "prompt=equip the iron sword and the leather helmet"