Make Sprite V1

Purpose

Generates sprite animations based on uploaded images. You can create sprite sheets in pixel art style or regular style.

Method and Path

POST /public/v1/sprite/make-sprite/v1

Authentication

See the Authentication page. Bearer token is required.

Required Headers:

Authorization: Bearer {your_api_key}

Request Fields

Field Name	Type	Required	Description
image	file	Yes	Image file to serve as the base for sprite generation
text	string	Yes	Text prompt for sprite generation
frame	integer	Yes	Number of frames to generate. Must be one of: 25, 36, 49, 64, 81, 100, 121, 144, 169
is_pixel	boolean	Yes	Whether the image is pixel art style. true or false

Response

Success Response (200 OK):

{
  "job_id": "uuid-string"
}

Field	Type	Description
job_id	string	Unique identifier for the created job. Use Get Job Status to retrieve results

Error / Validation Rules

Condition	HTTP Status	Error Message
Invalid image file	400	"Invalid image file"
frame value is not allowed	400	"frame should be one of 25, 36, 49, 64, 81, 100, 121, 144, 169"
Authentication failed	401	Invalid API key

Allowed Frame Values:

• 25, 36, 49, 64, 81, 100, 121, 144, 169

Async Job Behavior

This endpoint creates an asynchronous job. It immediately returns a job_id, and actual sprite generation occurs in the background.

Polling Method:

1. Save the job_id received in the response
2. Poll GET /public/v1/job/{job_id} to check status
3. When status becomes Succeed, check results in image_urls (GIF and individual frame images)

Status Flow: Pending → Succeed or Failed

Example Request

cURL (Pixel Art Style):

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

cURL (Regular Style):

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