Get task detail by ID

GET

/task/{taskId}

Returns a single task

Authorizations

• api_key

Parameters

Path Parameters

taskId

required

integer format: int64

ID of task to return

Responses

200

Successful operation

object

id

required

The unique identifier for the task.

string

status

required

The status of the task.

string

Allowed values: waiting running completed cancelled failed

createdAt

required

The time the task was created.

string format: date-time

updatedAt

required

The time the task was last updated.

string format: date-time

outputs

The outputs of the task.

object

mediaIds

The media IDs generated by the task. You can use these IDs to fetch detailed information about the generated media.

The images you generate are usually not permanently retained. You need to retrieve your images as soon as possible.

Array<string>

mediaUrls

The public URL of the images generated by the task.

The images you generate are usually not permanently retained. You need to retrieve your images as soon as possible. If an image is not available, it MAY be replaced by null in the array.

Array<string | null>

Headers

X-Trace-Id

string

A unique identifier for the request. This is useful for debugging and tracing requests.

404

Task not found

Headers

X-Trace-Id

string

A unique identifier for the request. This is useful for debugging and tracing requests.