PiAPI/Hailuo API-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

🟢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": "b21a4d03-8560-4d7e-b2db-711f1911f0c3",
        "model": "hailuo",
        "task_type": "video_generation",
        "status": "pending",
        "config": {
            "service_mode": "public",
            "webhook_config": {
                "endpoint": "",
                "secret": "string"
            }
        },
        "input": {
            "expand_prompt": true,
            "image_url": "https://static.flomoapp.com/file/2024-10-17/895452/1729167170.4526029_AnvNGfHP.jpg?OSSAccessKeyId=LTAI5tAXfrgN5cBQ7Bym1EcM&Expires=1742647898&Signature=238q7hJ7cQWShQ9FYwGHb%2B2hNng%3D",
            "model": "i2v-01",
            "prompt": "The flower slowly unfolds"
        },
        "output": {
            "percent": 0,
            "cover_url": "",
            "video_url": "",
            "download_url": "",
            "desc": "",
            "prompt_img_url": "",
            "status": 0,
            "user_origin_prompt": false,
            "width": 0,
            "height": 0,
            "model_id": "",
            "message": ""
        },
        "meta": {
            "created_at": "2025-03-19T12:53:47.893012908Z",
            "started_at": "0001-01-01T00:00:00Z",
            "ended_at": "0001-01-01T00:00:00Z",
            "usage": {
                "type": "point",
                "frozen": 2000000,
                "consume": 0
            },
            "is_using_private_pool": false
        },
        "detail": null,
        "logs": null,
        "error": {
            "code": 0,
            "raw_message": "",
            "message": "",
            "detail": null
        }
    },
    "message": "success"
}