スプライトリスキン V1

目的

既存スプライト画像の外見を変更し、新しいスタイルのスプライトを生成します。キャラクターの外見を変えたり、別のスタイルに変換する際に使用します。

メソッドとパス

POST /public/v1/sprite/reskin/v1

認証

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

必須ヘッダー:

Authorization: Bearer {your_api_key}

リクエストフィールド

フィールド名	タイプ	必須	説明
image	file	はい	リスキンする元スプライト画像ファイル
description	string	はい	スプライトに適用する変更内容の説明
resolution	string	はい	出力解像度。可能な値: `1K`, `2K`, `4K`
style	string	いいえ	スタイル指定。可能な値: `pixel`, `cartoon`, `sd`, `quater_view`

レスポンス

成功レスポンス (200 OK):

{
  "job_id": "uuid-string"
}

フィールド	タイプ	説明
job_id	string	作成されたジョブの一意識別子。Get Job Statusで結果を照会します

エラー / バリデーションルール

状況	HTTP状態	説明
Invalid image file	400	"Invalid image file"
resolution値が無効	422	`1K`, `2K`, `4K` 以外の値はvalidation error
style値が無効	422	`pixel`, `cartoon`, `sd`, `quater_view` 以外の値はvalidation error
認証失敗	401	無効なAPIキー

スタイルオプション:

pixel: ピクセルアートスタイル
cartoon: カートゥーンスタイル
sd: SD (Standard Definition) スタイル
quater_view: クォータービュー (isometric) スタイル

非同期ジョブの動作

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

ポーリング方法:

レスポンスで受け取ったjob_idを保存します
GET /public/v1/job/{job_id}をポーリングして状態を確認します
状態がSucceedになるとimage_urlsで結果を確認します

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

リクエスト例

cURL (基本スタイル):

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 (ピクセルスタイル指定):

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"

目的​

メソッドとパス​

認証​

リクエストフィールド​

レスポンス​

エラー / バリデーションルール​

非同期ジョブの動作​

リクエスト例​

目的