---
canonical_url: "https://docs.composio.dev/toolkits/runway"
markdown_url: "https://docs.composio.dev/toolkits/runway.md"
product: "platform"
version: null
last_updated: null
---

# Runway

Runway provides generative AI APIs for creating and transforming video, images, audio, avatars, voices, and media workflows.

- **Category:** media generation
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `RUNWAY`
- **Version:** 20261014_00

## Tools

### Cancel Task

**Slug:** `RUNWAY_CANCEL_TASK`

Cancel 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by a Runway generation tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Document

**Slug:** `RUNWAY_CREATE_DOCUMENT`

Create a Runway knowledge document from markdown or plain text for reuse by avatar workflows.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Descriptive document name, from 1 to 255 characters. |
| `content` | string | Yes | Markdown or plain text document content, from 1 to 200000 characters. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Ephemeral Upload

**Slug:** `RUNWAY_CREATE_EPHEMERAL_UPLOAD`

Create 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | Yes | 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Document

**Slug:** `RUNWAY_DELETE_DOCUMENT`

Permanently delete a Runway knowledge document by its ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID to permanently delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Image

**Slug:** `RUNWAY_GENERATE_IMAGE`

Start a Runway text-to-image or reference-guided image generation task and return its task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Sound Effect

**Slug:** `RUNWAY_GENERATE_SOUND_EFFECT`

Generate an audio effect from a text prompt and return the task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Speech

**Slug:** `RUNWAY_GENERATE_SPEECH`

Synthesize speech with Runway using an exact model-specific voice and option contract, then return the task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Video from Image

**Slug:** `RUNWAY_GENERATE_VIDEO_FROM_IMAGE`

Animate one or more input images with a selected Runway model and return the task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Generate Video from Text

**Slug:** `RUNWAY_GENERATE_VIDEO_FROM_TEXT`

Start a Runway text-to-video task with a model-specific typed request and return its task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Document

**Slug:** `RUNWAY_GET_DOCUMENT`

Get one Runway knowledge document, including its full content and the avatars that currently use it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `document_id` | string | Yes | Document ID returned by create or list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Organization

**Slug:** `RUNWAY_GET_ORGANIZATION`

Return the connected Runway organization's credit balance, monthly credit spend cap, exact per-model quotas, and current daily generation usage.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Task

**Slug:** `RUNWAY_GET_TASK`

Get 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `task_id` | string | Yes | Task ID returned by a Runway generation tool. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage

**Slug:** `RUNWAY_GET_USAGE`

Return daily Runway credit usage by model for an optional UTC date range of up to 90 days.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `RUNWAY_GET_WORKFLOW`

Get a published Runway workflow version and its graph so node IDs and output keys can be inspected before running the workflow.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Published workflow version ID returned by List Workflows. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow Invocation

**Slug:** `RUNWAY_GET_WORKFLOW_INVOCATION`

Get the current status, completed node output URLs, and node or invocation failure details for a Runway workflow invocation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `invocation_id` | string | Yes | Workflow invocation ID returned by Run Workflow. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Documents

**Slug:** `RUNWAY_LIST_DOCUMENTS`

List Runway knowledge documents one page at a time, with sorting and an opaque continuation cursor. List results omit full document content.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `RUNWAY_LIST_WORKFLOWS`

List the connected account's published Runway workflows and their available versions, ordered as returned by Runway.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Run Workflow

**Slug:** `RUNWAY_RUN_WORKFLOW`

Invoke a published Runway workflow, optionally overriding graph node outputs, and return the created workflow invocation ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Published workflow version ID returned by List Workflows. |
| `node_outputs` | object | No | Overrides keyed first by workflow graph node UUID, then by the node's output key. Inspect Get Workflow before supplying these values. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Transform Video

**Slug:** `RUNWAY_TRANSFORM_VIDEO`

Transform or restyle an existing video with Runway and return the created task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `discriminator` | string | No |  |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Document

**Slug:** `RUNWAY_UPDATE_DOCUMENT`

Change the name, content, or both for an existing Runway knowledge document. Provide at least one of name or content.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New document name, from 1 to 255 characters. Required unless content is provided. |
| `content` | string | No | New markdown or plain text content, from 1 to 200000 characters. Required unless name is provided. |
| `document_id` | string | Yes | Document ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upscale Image

**Slug:** `RUNWAY_UPSCALE_IMAGE`

Start a Runway image upscaling task and return its task ID and estimated credit cost.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `flavor` | string ("sublime" | "photo" | "photo_denoiser") | No | Optimization preset: sublime for illustration, photo for photography, or photo_denoiser for noisy photos. |
| `sharpen` | integer | No | Sharpness intensity from 0 (none) to 100. |
| `image_uri` | string | Yes | HTTPS, runway:// upload, or image data URI containing the image to upscale. |
| `smart_grain` | integer | No | Grain and texture enhancement from 0 to 100. |
| `scale_factor` | integer ("2" | "4" | "8" | "16") | No | Multiplier for each input dimension: 2, 4, 8, or 16. Runway defaults to 2. |
| `ultra_detail` | integer | No | Fine-detail enhancement from 0 to 100. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Upscale Video

**Slug:** `RUNWAY_UPSCALE_VIDEO`

Start a Runway video upscaling task and return its task ID and estimated credit cost.

#### Input Parameters

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

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |