Skip to main content

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 NameTypeRequiredDescription
imagefileRequiredOriginal image file to upscale (PNG, JPG, JPEG, etc.)
scalestringRequiredTarget 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 NameTypeDescription
job_idUUIDUnique identifier for the created job. Use this ID to check job status

Error / Validation Rules

HTTP Status CodeError ConditionDescription
400 Bad RequestInvalid image fileInvalid image file
401 UnauthorizedAuthentication failedInvalid API key or missing authentication header
404 Not FoundUser not foundUser associated with API key cannot be found
422 Unprocessable EntityValidation failedRequired 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:

  1. Send the image file and scale parameter to immediately receive a job_id
  2. Upscale processing occurs in the background
  3. Poll the GET /job/{job_id} endpoint to check status
  4. When status changes to Succeed, check the result image URL in image_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"
}