Image quality enhance
💡
Before using the API, make sure you have read our Authorization documentation to get set up with Vmake's API authentication.
Image quality enhance API allows you to upscale images' quality to elevate visual storytelling and wow your audience.
Create quality enhance task
🌐
POST https://open.vmake.ai/api/v1/image/quality-enhance
Since image quality enahnce is a time-consuming operation, the first step is to create an asynchronous task to enhance the image quality.
Request body
image string Required
💡
The supported image formats are JPEG and PNG.
Input an
image URL or Base64 encoded image data.Response body
The standard response body will be returned.
taskId string Required
The asynchronous task ID to query the status of the task.
{
"code": 0,
"message": "Success",
"data": {
"taskId": "0f1c2d3e-4f5g-6h7i-8j9k-a1b2c3d4e5f6"
}
}Query task status
🌐
GET https://open.vmake.ai/api/v1/image/quality-enhance/:taskId
Query the status of the task by the task ID.
Response body
The standard response body will be returned.
taskId string Required
The ID of the task.
status enum Required
The status of the task.
Allowed values:
pending: The task has been created and is waiting to be processed.running: Indicates that the task is processing.success: Indicates that the task has been successfully completed.error: Indicates that the task failed with error(s).
message string Required
The detailed message of the task status.
downloadUrl string Required
The download URL of the enhanced image.
{
"code": 0,
"message": "Success",
"data": {
"taskId": "0f1c2d3e-4f5g-6h7i-8j9k-a1b2c3d4e5f6",
"status": "success",
"message": "Success",
"downloadUrl": "ENHANCED_IMAGE_DOWNLOAD_URL"
}
}