Sprite Lite

Purpose

アップロードした1枚の画像からスプライトアニメーションを生成します。ウェブアプリの「スプライト生成」ページ (Sprite Lite & Plus) の Lite タブと同じ機能です。フレーム数は frame で選択し、ウェブページのスライダーに表示されている値をそのまま指定します。

クレジット消費: 5 (25フレーム)、7 (36)、9 (49)、11 (64)、13 (81)

Method and Path

POST /public/v1/sprite/lite

Authentication

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

必須ヘッダー:

Authorization: Bearer {your_api_key}

Request Fields

リクエストは multipart/form-data で送信します。

フィールド名	タイプ	必須	デフォルト	説明
image	file	はい		スプライトのベース画像 (PNG または JPEG)
text	string	はい		動きを説明するプロンプト。空白は削除され、テキストは空にできません
frame	integer	はい		フレーム。許可される値: 25, 36, 49, 64, 81
is_pixel	boolean	いいえ	false	ピクセルアート。添付画像がピクセルアートベースなら有効にしてください。
is_prompt_enhancement	boolean	いいえ	true	プロンプト補正。入力内容をもとに、スプライト生成に適した形へ整えます。

frameごとのクレジット

frame	クレジット
25	5
36	7
49	9
64	11
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 25, 36, 49, 64, 81"
textが空	400	"text must not be empty"
無効なAPIキー	401	"Invalid API key"
フィールド欠落	422	Validation error

Async Job Behavior

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

ポーリング方法:

1. レスポンスで受け取ったjob_idを保存します
2. GET /public/v1/job/{job_id}をポーリングして状態を確認します
3. 状態がSucceedになるとimage_urlsで結果を確認します (スプライトシートおよびGIF)

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

Example Request

cURL (ピクセルアート):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/lite" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png" \
-F "text=walking animation" \
-F "frame=64" \
-F "is_pixel=true"

cURL (一般スタイル、プロンプト補正オフ):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/lite" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/character.png" \
-F "text=running animation cycle" \
-F "frame=36" \
-F "is_prompt_enhancement=false"