Segment With Prompt API-Get Task

Developing

GET

/api/v1/task/{task_id}

This endpoint from PiAPI's Segment With Prompt API retrieves the output of the Segment With Prompt task where users could check their task output.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

OK-Successful Response

Body

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/api/v1/task/' \
--header 'X-API-Key;'

Response Example

200 - Example 1

{
    "code": 200,
    "data": {
        "task_id": "e5db4ce1-f064-4759-8072-320198be5028",
        "model": "Qubico/image-toolkit",
        "task_type": "segment",
        "status": "pending",
        "config": {
            "service_mode": "",
            "webhook_config": {
                "endpoint": "",
                "secret": ""
            }
        },
        "input": {
            "image": "https://st.mngbcn.com/rcs/pics/static/T5/fotos/outfit/S20/57034757_56-99999999_01.jpg",
            "prompt": "clothes,shoes",
            "negative_prompt": "pants",
            "segment_factor": -15
        },
        "output": null,
        "meta": {
            "created_at": "2025-03-20T16:10:38.133171095Z",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z",
            "usage": {
                "type": "llm",
                "frozen": 0,
                "consume": 100000
            },
            "is_using_private_pool": false
        },
        "detail": null,
        "logs": [],
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}

Modified at 2025-06-25 07:03:16

Segment With Prompt API

Image Upscale(Super Resolution) API