Upscale 1x
Upscale one of the 4 generated images by the Imagine endpoint to get a single image.
POST
https://api.apiframe.pro/upscale-1x
Headers
Content-Type
application/json
Authorization*
Your APIFRAME API Key
Body
parent_task_id
*
string
The task ID of the original task
index
*
string
The index of the image to upscale. Can be 1, 2, 3 or 4
webhook_url
string
The final result and updates of this task will be posted at this URL.
webhook_secret
string
Will be passed as x-webhook-secret
in the webhook call headers for authentication.
Response
// Success, the task has been submitted
{
"task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a"
}
This endpoint doesn't generate images instantly, you can use the Fetch endpoint to fetch the result or use webhooks.
The result (posted to the webhook_url
or retrieved with the Fetch endpoint) looks like this:
{
"task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
"image_url": "https://............./xxxxx.png",
"task_type": "upscale#1"
}
If the job is not completed, you will get a result like this:
{
"task_url": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
"task_type": "upscale#1",
"status": "processing",
"percentage": "80",
}
Code samples
const axios = require('axios');
let data = JSON.stringify({
"parent_task_id": "29e983ca-7e86-4017-a9e3-ef6fe9cd5f2a",
"index": "2"
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: 'https://api.apiframe.pro/upscale-1x',
headers: {
'Content-Type': 'application/json',
'Authorization': 'YOUR_API_KEY'
},
data : data
};
axios.request(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
Last updated
Was this helpful?