Skip to main content
GET
Get a task

Authorizations

Authorization
string
header
required

Your API key from the developer console, sent as Authorization: Bearer sk_live_.... The x-api-key: sk_live_... header is accepted as an alternative.

Path Parameters

task_id
string
required

The task id (task_ followed by 26 characters).

Example:

"task_01J9X7Z0K7Q8W3F2P1N6M5V4R3"

Response

The task.

A generation task. error is always present (null unless the task failed); other empty members are omitted.

id
string
required

Task id, task_ followed by 26 characters.

Example:

"task_01J9X7Z0K7Q8W3F2P1N6M5V4R3"

object
string
required
Allowed value: "task"
model
string
required

The model id the task was created with.

Example:

"wan/v3.0-spark/image-to-video"

task
enum<string>
required

The task type, the last segment of the model id.

Available options:
text-to-video,
image-to-video,
reference-to-video,
video-extend
status
enum<string>
required

queued → processing → one of the terminal states completed, failed, cancelled.

Available options:
queued,
processing,
completed,
failed,
cancelled
input
object
required

The accepted request body, without webhook_url and metadata.

error
object | null
required

Why the task failed. null unless status is failed.

credits
object
required
created_at
string<date-time>
required

When the task was created.

output
object

The result. Present on completed tasks until expires_at.

queue
object

Present while the task is queued.

webhook_url
string<uri>

The webhook URL sent with the task.

metadata
object

The metadata sent with the task.

started_at
string<date-time>

When generation started.

completed_at
string<date-time>

When the task reached completed, failed or cancelled.

expires_at
string<date-time>

When the output is removed, 7 days after completion.