Task management

Cancel or delete a task

Changed on

Tasks that are running, pending, or throttled can be canceled by invoking this method. Invoking this method for other tasks will delete them.

Refund eligibility is based on the task status observed by the server during cancellation. If that check observes RUNNING, cancellation does not refund credits. Task execution can advance concurrently with cancellation, so neither a refund nor successful cancellation guarantees that generation stops. A prior GET response reporting PENDING or THROTTLED does not guarantee a refund. Deleting a completed task does not refund its charge.

The output data associated with a deleted task will be deleted from persistent storage in accordance with our data retention policy. Aborted and deleted tasks will not be able to be fetched again in the future.

delete/v1/tasks/{id}

Request

  • Base URL
    https://api.dev.runwayml.com
  • URL
    https://api.dev.runwayml.com/v1/tasks/{id}
  • Auth
    HTTP bearer

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

The version of the RunwayML API being used. You can read more about versioning here.

Response

This endpoint will produce a 204 No Content response indicating successful cancellation or deletion. Calling this endpoint for tasks which have already been deleted or aborted will result in a 404: for idempotency purposes, it is safe to ignore these 404 errors.

Changes

  • 6dab1bdab5d3Revision changes
    • breaking

      added the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ to the path request parameter id

  • c2a88516fa0cRevision changes
    • info

      removed the pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ from the path request parameter id