Reskin Sprite V1

Purpose

Changes the appearance of an existing sprite image to generate a new style sprite. Used when changing a character's appearance or converting to a different style.

Method and Path

POST /public/v1/sprite/reskin/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	Original sprite image file to reskin
description	string	Yes	Description of the changes to apply to the sprite
resolution	string	Yes	Output resolution. Possible values: 1K, 2K, 4K
style	string	No	Style specification. Possible values: pixel, cartoon, sd, quater_view

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	Description
Invalid image file	400	"Invalid image file"
resolution value is invalid	422	Values other than 1K, 2K, 4K will result in validation error
style value is invalid	422	Values other than pixel, cartoon, sd, quater_view will result in validation error
Authentication failed	401	Invalid API key

Style Options:

• pixel: Pixel art style
• cartoon: Cartoon style
• sd: SD (Standard Definition) style
• quater_view: Quarter view (isometric) style

Async Job Behavior

This endpoint creates an asynchronous job. It immediately returns a job_id, and actual reskin processing 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

Status Flow: Pending → Succeed or Failed

Example Request

cURL (Default Style):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/reskin/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/sprite.png" \
-F "description=change the warrior character armor to golden" \
-F "resolution=2K"

cURL (Pixel Style Specified):

curl -X POST "https://api.aetherforgeai.com/public/v1/sprite/reskin/v1" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/sprite.png" \
-F "description=convert the character to pixel art style" \
-F "resolution=1K" \
-F "style=pixel"