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 Name | Type | Required | Description |
|---|---|---|---|
job_id | UUID | Required | Unique identifier for the job to retrieve (UUID format) |
Response
GetJobStatusResponse
| Field Name | Type | Description |
|---|---|---|
job_id | UUID | Unique identifier for the job |
status | string | Job status. Possible values: Pending, Succeed, Failed |
image_urls | list[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 Code | Error Condition | Description |
|---|---|---|
401 Unauthorized | Authentication failed | Invalid API key or missing authentication header |
404 Not Found | Job not found | No job found for the given job_id |
422 Unprocessable Entity | Invalid job_id format | job_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_idfrom job creation, poll this endpoint to check status - Initial status is
Pending - When complete,
statuschanges toSucceedandimage_urlscontains the result image URLs - If failed,
statuschanges toFailed - 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": []
}