Image Upscale(Super Resolution) API

Request

Header Params

x-api-key

string

required

Your API Key for authorization

Body Params application/json

model

enum<string>

required

Allowed value:

Qubico/image-toolkit

task_type

enum<string>

required

Allowed value:

upscale

input

object

required

image

string

required

the url of the image that you want to upscale, both width and height of the image should be no more than 2048 pixels

scale

integer

required

upscale factor, can only set to be 2,4,8

face_enhance

boolean

optional

Example

{
    "model": "Qubico/image-toolkit",
    "task_type": "upscale",
    "input": {
        "image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg",
        "scale": 2,
        "face_enhance": true
    }
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'x-api-key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "model": "Qubico/image-toolkit",
    "task_type": "upscale",
    "input": {
        "image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg",
        "scale": 2,
        "face_enhance": true
    }
}'

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

task_type

string

required

status

string

required

task_info

object

required

task_result

object

required

message

string

required

Example

{
    "code": 200,
    "data": {
        "task_id": "a62ba0d0-184f-4a0e-9f9e-2e38c7fec79f",
        "model": "Qubico/image-toolkit",
        "task_type": "upscale",
        "status": "",
        "config": {
            "service_mode": "",
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        },
        "input": {
            "image": "https://img.theapi.app/ephemeral/4b0211eb-7788-4b30-bf15-4c5707b66d8e.jpg",
            "scale": 2,
            "face_enhance": false
        },
        "output": null,
        "meta": {
            "created_at": "2024-10-23T10:35:31.039487176Z",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z"
        },
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

Image Upscale(Super Resolution) API

Pricing#

Request

Request samples

Responses

Pricing