Sprite Plus
Purpose
開始フレームと任意の終了フレームからスプライトアニメーションを生成します。ウェブアプリの「スプライト生成」ページ (Sprite Lite & Plus) の Plus タブと同じ機能です。フレーム数は frame で選択し、ウェブページのスライダーに表示されている値をそのまま指定します。
クレジット消費: 9 (49フレーム)、13 (81フレーム)
Method and Path
POST /public/v1/sprite/plus
Authentication
認証ページを参照してください。Bearerトークンが必要です。
必須ヘッダー:
Authorization: Bearer {your_api_key}
Request Fields
リクエストは multipart/form-data で送信します。
| フィールド名 | タイプ | 必須 | デフォルト | 説明 |
|---|---|---|---|---|
| start_image | file | はい | 開始フレーム (PNG または JPEG) | |
| end_image | file | いいえ | 終了フレーム（任意） (PNG または JPEG) | |
| text | string | はい | 動きを説明するプロンプト。空白は削除され、テキストは空にできません | |
| frame | integer | はい | フレーム。許可される値: 49, 81 | |
| is_pixel | boolean | いいえ | false | ピクセルアート。添付画像がピクセルアートベースなら有効にしてください。 |
| is_prompt_enhancement | boolean | いいえ | true | プロンプト補正。入力内容をもとに、スプライト生成に適した形へ整えます。 |
frameごとのクレジット
| frame | クレジット |
|---|---|
| 49 | 9 |
| 81 | 13 |
Response
成功レスポンス (200 OK):
{
"job_id": "uuid-string"
}
| フィールド | タイプ | 説明 |
|---|---|---|
| job_id | string | 作成されたジョブの一意識別子。Get Job Statusで結果を照会します |
Error / Validation Rules
| 状況 | HTTP状態 | エラーメッセージ |
|---|---|---|
| いずれかの画像が有効な PNG または JPEG ファイルでない | 400 | "Invalid image file" |
| frame値が許可された値でない | 400 | "frame should be one of 49, 81" |
| textが空 | 400 | "text 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で結果を確認します (スプライトシートおよびGIF)
状態フロー: Pending → Succeed または Failed
Example Request
cURL (開始フレームのみ):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/plus" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "start_image=@/path/to/character.png" \
-F "text=walking animation" \
-F "frame=49" \
-F "is_pixel=true"
cURL (開始 + 終了フレーム):
curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/plus" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "start_image=@/path/to/character_start.png" \
-F "end_image=@/path/to/character_end.png" \
-F "text=running animation cycle" \
-F "frame=81"