Upscale: Creative and Subtle

The Upscale (Subtle) option doubles the size of your image and keeps details very similar to the original adds Upscale (Creative) adds details to the image. Of course you first need to Upscale 1x.

POST https://api.apiframe.pro/upscale-alt

Headers

NameValue

Content-Type

application/json

Authorization*

Your APIFRAME API Key

Body

NameTypeDescription

parent_task_id*

string

The task ID of the image to upscale, you get it from the /upscale-1x request.

type*

string

The type of upscale. Can be subtle or creative

webhook_url

string

The final result 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": 1234567890123
}

This endpoint doesn't generate images instantly, you can use the Fetch endpoint to fetch the result or use webhooks.

The result (posed to the webhook_url or retrieved from the Fetch endpoint) looks like this:

{
    "task_id": "123456789123",
    "image_url": "https://............./xxxxx.png"
}

If the job is not completed, you will get a result like this:

{
    "task_id": "123456789123",
    "status": "processing",
    "percentage": "80"
}

Code samples

const axios = require('axios');
let data = JSON.stringify({
  "parent_task_id": "12345678941233",
  "type": "creative"
});

let config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://api.apiframe.pro/upscale-alt',
  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