스프라이트 리스킨 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 | 생성된 작업의 고유 식별자. 작업 상태 조회로 결과를 조회합니다 |
오류 / 유효성 검사 규칙
| 상황 | 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"