주요 콘텐츠로 건너뛰기

GET /job/{job_id}

목적​

이 엔드포인트는 비동기 작업의 현재 상태와 결과를 조회합니다. 작업 ID(job_id)를 통해 이미지 생성, 스프라이트 생성 등의 작업 상태를 확인할 수 있습니다.

메서드 및 경로​

  • HTTP 메서드: GET
  • 경로: /public/v1/job/{job_id}

인증​

이 엔드포인트는 Bearer Token 인증이 필요합니다. 자세한 내용은 인증 가이드를 참조하세요.

필수 헤더:

Authorization: Bearer {your_api_key}

요청 필드​

경로 매개변수​

필드명타입필수 여부설명
job_idUUID필수조회할 작업의 고유 식별자 (UUID 형식)

응답​

GetJobStatusResponse​

필드명타입설명
job_idUUID작업의 고유 식별자
statusstring작업 상태. 가능한 값: Pending, Succeed, Failed
image_urlslist[string]완료된 이미지 URL 목록. 작업 성공 시에만 포함됨

상태 값​

  • Pending: 작업이 진행 중이거나 대기 중인 상태
  • Succeed: 작업이 성공적으로 완료됨
  • Failed: 작업 처리 중 오류가 발생함

오류 / 유효성 검사 규칙​

HTTP 상태 코드오류 상황설명
401 Unauthorized인증 실패유효하지 않은 API 키 또는 누락된 인증 헤더
404 Not Found작업 없음해당 job_id에 해당하는 작업을 찾을 수 없음
422 Unprocessable Entity잘못된 job_id 형식job_id는 유효한 UUID여야 함

비동기 작업 동작​

이 엔드포인트는 비동기 작업의 상태를 조회하는 데 사용됩니다. 작업 생성 엔드포인트(예: /image-tune/upscale)는 즉시 job_id를 반환하고, 실제 처리는 백그라운드에서 진행됩니다.

폴링 전략:

  • 작업 생성 후 job_id를 받으면 이 엔드포인트로 폴링하여 상태를 확인합니다
  • 초기 상태는 Pending입니다
  • 작업 완료 시 status가 Succeed로 변경되고 image_urls에 결과 이미지 URL이 포함됩니다
  • 작업 실패 시 status가 Failed로 변경됩니다
  • 폴링 간격은 1-2초를 권장합니다

요청 예시​

cURL​

curl -X GET "https://api.aetherforgeai.com/public/v1/job/550e8400-e29b-41d4-a716-446655440000" \
-H "Authorization: Bearer YOUR_API_KEY"

응답 예시 (성공 - Pending)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Pending",
  "image_urls": []
}

응답 예시 (성공 - 완료)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Succeed",
  "image_urls": ["https://cdn.aetherforgeai.com/images/generated_abc123.png"]
}

응답 예시 (실패)​

{
  "job_id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "Failed",
  "image_urls": []
}