Enhance Quality
Purpose
This endpoint enhances the quality of uploaded images at higher resolutions. It expands the original image to 1K, 2K, or 4K resolution to produce sharper, higher-quality images.
Method and Path
- HTTP Method:
POST - Path:
/public/v1/image-tune/upscale
Authentication
This endpoint requires Bearer Token authentication. See the Authentication Guide for details.
Required Headers:
Authorization: Bearer {your_api_key}
Request Fields
Form Data (multipart/form-data)
| Field Name | Type | Required | Description |
|---|---|---|---|
image | file | Required | Original image file to upscale (PNG, JPG, JPEG, etc.) |
scale | string | Required | Target resolution. Possible values: "1K", "2K", "4K" |
Scale Values
"1K": Upscale to 1024px resolution"2K": Upscale to 2048px resolution"4K": Upscale to 4096px resolution
Response
JobIdResponse
| Field Name | Type | Description |
|---|---|---|
job_id | UUID | Unique identifier for the created job. Use this ID to check job status |
Error / Validation Rules
| HTTP Status Code | Error Condition | Description |
|---|---|---|
400 Bad Request | Invalid image file | Invalid image file |
401 Unauthorized | Authentication failed | Invalid API key or missing authentication header |
404 Not Found | User not found | User associated with API key cannot be found |
422 Unprocessable Entity | Validation failed | Required field missing or invalid scale value |
Async Job Behavior
This endpoint is processed asynchronously. It immediately returns a job_id, and actual upscale processing occurs in the background.
Job Flow:
- Send the image file and scale parameter to immediately receive a
job_id - Upscale processing occurs in the background
- Poll the
GET /job/{job_id}endpoint to check status - When
statuschanges toSucceed, check the result image URL inimage_urls
Recommended Polling Interval: 1-2 seconds
Example Request
cURL
curl -X POST "https://api.aetherforgeai.com/public/v1/image-tune/upscale" \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@/path/to/your/image.png" \
-F "scale=2K"
Response Example
{
"job_id": "550e8400-e29b-41d4-a716-446655440000"
}