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-Returns the status and result of the task

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,
    "message": "success",
    "data": {
        "task_id": "0f647527-12bd-48b1-b813-111111111",
        "model": "Qubico/hug-video", 
        "task_type": "image_to_video",
        "status": "", // pending/processing/failed/completed
        "input": {}, 
        "output": {}, 
        "meta": { 
        },
        "logs": [],
        "error": {
            "code": 1100,
            "message": ""
        } 
    }
}

🟠401Unauthorized

🟠404Record Not Found

Request

Request samples

Responses