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

{
  "choices": [
    {
      "finish_reason": "stop",
      "index": 0,
      "logprobs": null,
      "message": {
        "content": "Hello! How can I assist you today?",
        "refusal": null,
        "role": "assistant"
      }
    }
  ],
  "created": 1742390255,
  "id": "chatcmpl-BCnaZUo5Bm2Lh0kMjzea9i8rQiQVb",
  "model": "gpt-4o-mini-2024-07-18",
  "object": "chat.completion",
  "system_fingerprint": "fp_b705f0c291",
  "usage": {
    "completion_tokens": 10,
    "completion_tokens_details": {
      "accepted_prediction_tokens": 0,
      "audio_tokens": 0,
      "reasoning_tokens": 0,
      "rejected_prediction_tokens": 0
    },
    "prompt_tokens": 19,
    "prompt_tokens_details": {
      "audio_tokens": 0,
      "cached_tokens": 0
    },
    "total_tokens": 29
  }
}