Sign in
Task management

Get task detail

Return details about a task. Consumers of this API should not expect updates more frequent than once every five seconds for a given task.

get/v1/tasks/{id}

Path parameters

idstring uuid required

The ID of a previously-submitted task that has not been canceled or deleted.

Headers

X-Runway-Version'2024-11-06' required

Response

The task status.

idstring uuid required

The ID of the task being returned.

status'RUNNING' | 'SUCCEEDED' | 'FAILED' | 'PENDING' | 'CANCELLED' | 'THROTTLED' required
  • PENDING tasks have been enqueued and are waiting to run.
  • THROTTLED tasks are waiting to be enqueued until other jobs have finished running.
  • RUNNING tasks are currently being processed.
  • SUCCEEDED tasks have completed successfully.
  • FAILED tasks have failed.
  • CANCELLED tasks have been aborted.
createdAtstring date-time required

The timestamp that the task was submitted at.

failurestring

If the status is FAILED, this will contain a human-friendly reason for the failure.

failureCodestring

If the task has a status of FAILED, this contains a machine-readable error code. This is a dot-separated string, with the leftmost segment being the most generic and the rightmost segment being the most specific. For example, SAFETY.INPUT.TEXT would indicate that the task failed due to a content moderation error on the input text.

outputstring[]

If the status is SUCCEEDED, this will contain an array of strings. Each string will be a URL that returns an output from the task. URLs expire within 24-48 hours; fetch the task again to get fresh URLs. It is expected that you download the assets at these URLs and store them in your own storage system.

progressnumber

If the task has a status of RUNNING, this will contain a floating point number between 0 and 1 representing the progress of the generation.

Changes