Skip to main content
Runway logo
  • Category: media generation
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 22
  • Triggers: 0
  • Slug: RUNWAY
  • Version: 20261014_00

Tools

Slug: RUNWAY_CANCEL_TASKCancel a running Runway task or delete its task record. Returns success only when Runway confirms the operation; an already absent task remains a 404 error.

Input Parameters

string
required
Task ID returned by a Runway generation tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_CREATE_DOCUMENTCreate a Runway knowledge document from markdown or plain text for reuse by avatar workflows.

Input Parameters

string
required
Descriptive document name, from 1 to 255 characters.
string
required
Markdown or plain text document content, from 1 to 200000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_CREATE_EPHEMERAL_UPLOADCreate only a temporary Runway media upload slot and return its presigned multipart form details and runway:// URI. This action does not upload file bytes; POST them separately to upload_url using fields before using runway_uri.

Input Parameters

string
required
Filename, including an extension representative of the file contents. It must be 3-255 characters and use a Runway-supported image, video, or audio media type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_DELETE_DOCUMENTPermanently delete a Runway knowledge document by its ID.

Input Parameters

string
required
Document ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GENERATE_IMAGEStart a Runway text-to-image or reference-guided image generation task and return its task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GENERATE_SOUND_EFFECTGenerate an audio effect from a text prompt and return the task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GENERATE_SPEECHSynthesize speech with Runway using an exact model-specific voice and option contract, then return the task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GENERATE_VIDEO_FROM_IMAGEAnimate one or more input images with a selected Runway model and return the task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GENERATE_VIDEO_FROM_TEXTStart a Runway text-to-video task with a model-specific typed request and return its task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_DOCUMENTGet one Runway knowledge document, including its full content and the avatars that currently use it.

Input Parameters

string
required
Document ID returned by create or list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_ORGANIZATIONReturn the connected Runway organization’s credit balance, monthly credit spend cap, exact per-model quotas, and current daily generation usage.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_TASKGet the current status, cost, output URLs, and failure details for a Runway generation task. Runway does not update a task more often than every five seconds.

Input Parameters

string
required
Task ID returned by a Runway generation tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_USAGEReturn daily Runway credit usage by model for an optional UTC date range of up to 90 days.

Input Parameters

string
Inclusive UTC start date in YYYY-MM-DD format. Runway defaults to 30 days before the current date when omitted.
string
Exclusive UTC end date in YYYY-MM-DD format. It must be after start_date and at most 90 days later.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_WORKFLOWGet a published Runway workflow version and its graph so node IDs and output keys can be inspected before running the workflow.

Input Parameters

string
required
Published workflow version ID returned by List Workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_GET_WORKFLOW_INVOCATIONGet the current status, completed node output URLs, and node or invocation failure details for a Runway workflow invocation.

Input Parameters

string
required
Workflow invocation ID returned by Run Workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_LIST_DOCUMENTSList Runway knowledge documents one page at a time, with sorting and an opaque continuation cursor. List results omit full document content.

Input Parameters

string ("createdAt" | "updatedAt")
Document timestamp used to sort results.
integer
Maximum documents to return in this page (1-100).
string ("asc" | "desc")
Sort documents in ascending or descending order.
string
Opaque cursor returned as next_cursor by a previous call. Omit it for the first page and pass it back unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_LIST_WORKFLOWSList the connected account’s published Runway workflows and their available versions, ordered as returned by Runway.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_RUN_WORKFLOWInvoke a published Runway workflow, optionally overriding graph node outputs, and return the created workflow invocation ID.

Input Parameters

string
required
Published workflow version ID returned by List Workflows.
object
Overrides keyed first by workflow graph node UUID, then by the node’s output key. Inspect Get Workflow before supplying these values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_TRANSFORM_VIDEOTransform or restyle an existing video with Runway and return the created task ID and estimated credit cost.

Input Parameters

string

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_UPDATE_DOCUMENTChange the name, content, or both for an existing Runway knowledge document. Provide at least one of name or content.

Input Parameters

string
New document name, from 1 to 255 characters. Required unless content is provided.
string
New markdown or plain text content, from 1 to 200000 characters. Required unless name is provided.
string
required
Document ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_UPSCALE_IMAGEStart a Runway image upscaling task and return its task ID and estimated credit cost.

Input Parameters

string ("sublime" | "photo" | "photo_denoiser")
Optimization preset: sublime for illustration, photo for photography, or photo_denoiser for noisy photos.
integer
Sharpness intensity from 0 (none) to 100.
string
required
HTTPS, runway:// upload, or image data URI containing the image to upscale.
integer
Grain and texture enhancement from 0 to 100.
integer ("2" | "4" | "8" | "16")
Multiplier for each input dimension: 2, 4, 8, or 16. Runway defaults to 2.
integer
Fine-detail enhancement from 0 to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RUNWAY_UPSCALE_VIDEOStart a Runway video upscaling task and return its task ID and estimated credit cost.

Input Parameters

string ("vivid" | "natural")
Processing style: vivid enhances color and detail; natural favors faithful reproduction.
integer
Sharpness intensity from 0 for none to 100.
boolean
Whether to increase the output frame rate.
string
required
Video to upscale as an HTTPS URL, runway:// upload URI, or video data URI; maximum duration is 30 seconds.
integer
Amount of AI-generated detail to add, from 0 for faithful upscaling to 100.
string ("720p" | "1k" | "2k" | "4k")
Target output resolution from 720p to 4k; defaults upstream to 2k.
integer
Grain and texture enhancement amount from 0 to 100.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not