주요 콘텐츠로 건너뛰기

아이템 장착

목적​

아이템 시트의 아이템을 캐릭터 베이스 이미지에 장착하여 장착된 변형 이미지를 생성합니다. 웹 앱의 "아이템 장착" 페이지와 동일한 기능입니다.

크레딧 비용: 5

메서드 및 경로​

POST /public/v1/image-tune/equip-variation

인증​

인증 페이지를 참고하세요. Bearer 토큰이 필요합니다.

필수 헤더:

Authorization: Bearer {your_api_key}

요청 필드​

요청은 multipart/form-data로 전송합니다.

필드명타입필수설명
character_imagefile예캐릭터 베이스 이미지 (PNG 또는 JPEG)
item_sheet_imagefile예아이템 시트 이미지 (PNG 또는 JPEG)
promptstring예아이템을 어떻게 장착할지 설명하는 프롬프트. 공백은 제거되며 프롬프트는 비어 있으면 안 됩니다

응답​

성공 응답 (200 OK):

{
"job_id": "uuid-string"
}
필드타입설명
job_idstring생성된 작업의 고유 식별자. 작업 상태 조회로 결과를 조회합니다

오류 / 유효성 검사 규칙​

상황HTTP 상태에러 메시지
둘 중 하나의 이미지가 유효한 PNG 또는 JPEG 파일이 아님400"Invalid image file"
prompt가 비어 있음400"prompt must not be empty"
유효하지 않은 API 키401"Invalid API key"
필드 누락422Validation error

두 이미지 모두 업로드 전에 검증되므로, 실패한 요청이 부분 업로드를 남기지 않습니다.

비동기 작업 동작​

이 엔드포인트는 비동기 작업을 생성합니다. 요청 즉시 job_id를 반환하고, 생성은 백그라운드에서 진행됩니다.

폴링 방법:

  1. 응답으로 받은 job_id를 저장합니다
  2. GET /public/v1/job/{job_id}를 폴링하여 상태를 확인합니다
  3. 상태가 Succeed가 되면 image_urls에서 결과를 확인합니다

상태 흐름: Pending → Succeed 또는 Failed

요청 예시​

cURL:

curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/equip-variation" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "character_image=@/path/to/character.png" \
-F "item_sheet_image=@/path/to/item_sheet.png" \
-F "prompt=equip the iron sword and the leather helmet"