PiAPI/Image Upscale-Get Task

Request

Path Params

task_id

string

required

Header Params

X-API-Key

string

required

Your API KEY used for request authorization

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200OK

application/json

OK-Successful Response

Body

code

integer

optional

data

object

optional

task_id

string

optional

input

string

optional

status

string

optional

metadata

object

optional

task

object

optional

works

array [object {18}]

optional

message

string

optional

Example

{
    "code": 200,
    "data": {
        "task_id": "5ae839ab-ae0b-4a01-8d6e-b351c0cbc888",
        "model": "Qubico/image-toolkit",
        "task_type": "upscale",
        "status": "pending",
        "config": {
            "service_mode": "",
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        },
        "input": {
            "image": "https://static.flomoapp.com/file/2024-10-13/895452/1728800202.451645_xYWPucOx.jpg?OSSAccessKeyId=LTAI5tAXfrgN5cBQ7Bym1EcM&Expires=1742648337&Signature=wDuQPlO4VwL2BFtGAkhZU44%2BkFU%3D",
            "scale": 2,
            "face_enhance": true
        },
        "output": null,
        "meta": {
            "created_at": "2025-03-20T16:17:03.232664731Z",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z",
            "usage": {
                "type": "llm",
                "frozen": 0,
                "consume": 10000
            },
            "is_using_private_pool": false
        },
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error