Get Task - PiAPI

Request

Path Params

task_id

string

required

Header Params

x-api-key

string

required

Your API key for authorization

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

Example

{
  "code": 200,
  "data": {
    "task_id": "e49d1460-d7db-47b8-a430-61b3415a6376",
    "model": "Qubico/tts",
    "task_type": "zero-shot",
    "status": "pending",
    "config": {
      "service_mode": "",
      "webhook_config": {
        "endpoint": "",
        "secret": ""
      }
    },
    "input": {
      "gen_text": "captain teemo, on duty!",
      "ref_audio": "https://replicate.delivery/pbxt/LnHEJTVWhjLcpGQJTBralyztLwl8diaLyHjP2a1KXJ8dxVWv/Teemo_Original_Taunt.ogg",
      "ref_text": "never underestimate the power of the scout's code"
    },
    "output": null,
    "meta": {
      "created_at": "2025-03-19T13:07:09.716957752Z",
      "started_at": "0001-01-01T00:00:00Z",
      "ended_at": "0001-01-01T00:00:00Z",
      "usage": {
        "type": "llm",
        "frozen": 0,
        "consume": 4500
      },
      "is_using_private_pool": false
    },
    "detail": null,
    "logs": [],
    "error": {
      "code": 0,
      "raw_message": "",
      "message": "",
      "detail": null
    }
  },
  "message": "success"
}

🟠400Bad Request