Workflows

Run a published workflow

Changed on

Start a new task to execute a published workflow. You can optionally provide custom input values via nodeOutputs to override the defaults defined in the workflow graph.

post/v1/workflows/{id}

Request

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

Path parameters

idstring uuid required

The ID of the published workflow to run. You can copy this value from the developer portal.

Headers

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

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

Request body

nodeOutputsobject

Optional node outputs to override default values. Keys are node IDs from the workflow graph, values are objects mapping output keys to typed values.

Response

The response from running a workflow.

idstring uuid required

The ID of the workflow invocation that was created.

Changes

  • 4491b57b5860Revision changes
    • breaking

      removed subschema #1 subschema #3 from the //// request property anyOf list

    • breaking

      removed subschema #1 subschema #3 from the //// request property anyOf list

    • info

      added subschema #1 subschema #3 to the //// request property anyOf list

    • info

      added subschema #1 subschema #3 to the //// request property anyOf list

  • 6f5bc53a0d36Revision changes
    • warning

      changed the pattern of the request property ///// from ^https://.* to ^https:\/\/.*

    • warning

      changed the pattern of the request property ///// from ^https://.* to ^https:\/\/.*

    • warning

      changed the pattern of the request property ///// from ^https://.* to ^https:\/\/.*