Skip to main content

GET /job/{job_id}

Purpose

This endpoint retrieves the current status and results of an asynchronous job. You can check the status of image generation, upscale, inpaint, layer split, and other jobs using the job ID.

Method and Path

  • HTTP Method: GET
  • Path: /public/v1/job/{job_id}

Authentication

This endpoint requires Bearer Token authentication. See the Authentication Guide for details.

Required Headers:

Authorization: Bearer {your_api_key}

Request Fields

Path Parameters

Field NameTypeRequiredDescription
job_idUUIDRequiredUnique identifier for the job to retrieve (UUID format)

Response

GetJobStatusResponse

Field NameTypeDescription
job_idUUIDUnique identifier for the job
statusstringJob status. Possible values: Pending, Succeed, Failed
image_urlslist[string]List of completed image URLs. Only included when job succeeds

Status Values

  • Pending: The job is in progress or queued
  • Succeed: The job completed successfully
  • Failed: An error occurred during job processing

Error / Validation Rules

HTTP Status CodeError ConditionDescription
401 UnauthorizedAuthentication failedInvalid API key or missing authentication header
404 Not FoundJob not foundNo job found for the given job_id
422 Unprocessable EntityInvalid job_id formatjob_id must be a valid UUID

Async Job Behavior

This endpoint is used to retrieve the status of asynchronous jobs. Job creation endpoints (e.g., /image-tune/upscale) immediately return a job_id, and actual processing occurs in the background.

Polling Strategy:

  • After receiving the job_id from job creation, poll this endpoint to check status
  • Initial status is Pending
  • When complete, status changes to Succeed and image_urls contains the result image URLs
  • If failed, status changes to Failed
  • Recommended polling interval: 1-2 seconds

Example Request

cURL

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

Response Example (Success - Pending)

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

Response Example (Success - Completed)

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

Response Example (Failed)

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