runway · git:20260814.859ce81 · 2026-08-14 · sha256 d8d89cbf8a0d8196
runway git:20260814.859ce81A
Immutable. This exact content is served forever at /api/v1/blob/d8d89cbf8a0d8196.
---
name: runway
description: Agent-callable Runway tools — generate images and video from text or images, edit and upscale media, animate characters, generate speech and sound effects, and run marketing recipes, plus track generation jobs. Use when the user mentions Runway or wants to generate, edit, or upscale AI media, even if they don't name Runway explicitly.
license: Elastic-2.0
compatibility: Run `npm install --omit=dev` in this directory, then `node cli.js`. The TypeScript source needs Node.js 22.18+; on older Node, run `cli.js` for build-it-yourself / prebuilt / alternative-runtime options.
metadata:
source: https://github.com/zapier/connectors/blob/main/apps/runway/SKILL.md
title: Runway
api-docs: https://docs.dev.runwayml.com/
zapier-app-key: RunwayCLIAPI
---
# Runway
<!-- BEGIN:skill-intro -->
Agent-callable tools for [Runway](https://docs.dev.runwayml.com/) generative media (`https://api.dev.runwayml.com/v1`): generate images and video from text or an image, edit/restyle and upscale existing media, animate a character from a driving performance, generate speech, sound effects, voice conversions and dubs, and run Runway's one-shot marketing "recipes" (product ads, campaign images, UGC, product swap, ad localization). Every generation is **asynchronous** — the generate/audio/recipe tools return a task id and you poll `getTask` for the finished asset URLs (or pass `wait: true` to block until the job finishes). Generated asset URLs **expire in 24-48 hours**, so download and rehost them promptly.
<!-- legal:disclaimer -->
_Independent, unofficial connector for Runway. Not affiliated with, endorsed by, or sponsored by Runway. "Runway" is a trademark of its owner, used only to identify the service this connector works with._
<!-- /legal:disclaimer -->
<!-- END:skill-intro -->
## When to use this
<!-- BEGIN:skill-use-cases -->
- **Generate visual media** — make an image (`generateImage`), a video from an image (`generateVideoFromImage`) or from text (`generateVideoFromText`), restyle a video (`editVideo`), upscale an image or video (`upscaleImage` / `upscaleVideo`), or animate a character (`animateCharacter`).
- **Generate audio** — text-to-speech (`generateSpeech`), sound effects (`generateSoundEffect`), voice conversion (`convertVoice`), dubbing (`dubAudio`), or voice isolation (`isolateVoice`).
- **Run marketing recipes** — one-shot higher-level jobs: `generateProductAd`, `generateCampaignImages`, `generateMarketingImage`, `swapProduct`, `generateProductUgc`, `generateMultiShotVideo`, `localizeAd`.
- **Track jobs and account** — check a job with `getTask`, stop one with `cancelTask`, and read credits / concurrency limits with `getOrganization` / `getCreditUsage`.
<!-- END:skill-use-cases -->
## Setup
This is an [agentskills.io](https://agentskills.io) skill.
If the connector has not been installed as a skill yet, install it first with `npx skills add zapier/connectors --skill runway` (or your harness's own skill-install mechanism), then continue here. Installing the skill copies these files, not dependencies. Before running the CLI, a local MCP server, or `zapier-sdk` auth commands, run `npm install --omit=dev` here once. Importing the published package as a dependency in your own project instead? That `npm install` already resolves everything — see [`references/use-as-sdk.md`](references/use-as-sdk.md).
Want the actual repo source instead — to browse `references/`, run this connector's tests, or hack on it? See [`README.md`](README.md#cloning-the-source) for a scoped `git clone`.
The connector runs on **Node.js 22.18+**. Pick the reference that matches how you're running it, and load it before doing anything else:
| You have... | Load |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------ |
| An MCP-aware client — tools may already be loaded (e.g. `mcp__runway__<tool>`), or you can register a local server yourself (or guide the user to) | [`references/use-as-mcp.md`](references/use-as-mcp.md) |
| Terminal / subprocess access (you can run `node`) | [`references/use-as-cli.md`](references/use-as-cli.md) |
| Only your own code, importing this package as a dependency | [`references/use-as-sdk.md`](references/use-as-sdk.md) |
| No tool access, no terminal, no ability to import this package — you write your own code that calls the Runway API directly (e.g. a code-execution sandbox) | [`references/use-as-recipe.md`](references/use-as-recipe.md) |
## Scripts
<!-- BEGIN:skill-connections-note? -->
All scripts use the single connection `runway`. The generate, audio, and recipe tools are asynchronous — they return a task id (poll `getTask`), or accept `wait: true` to block until the job reaches a terminal state.
<!-- END:skill-connections-note -->
<!-- BEGIN:skill-scripts-table -->
| Script | Script name | Connections | Description |
| ------------------------------------------------------------------------ | ------------------------ | ----------- | ---------------------------------------------------------------------------------- |
| [`scripts/generateImage.ts`](scripts/generateImage.ts) | `generateImage` | `runway` | Generate an image from a text prompt, optionally guided by 1-3 reference images. |
| [`scripts/generateVideoFromImage.ts`](scripts/generateVideoFromImage.ts) | `generateVideoFromImage` | `runway` | Generate a video that animates a source image, guided by a motion prompt. |
| [`scripts/generateVideoFromText.ts`](scripts/generateVideoFromText.ts) | `generateVideoFromText` | `runway` | Generate a video from a text prompt alone (no source image). |
| [`scripts/editVideo.ts`](scripts/editVideo.ts) | `editVideo` | `runway` | Transform or restyle an existing video with a text prompt (Aleph). |
| [`scripts/upscaleImage.ts`](scripts/upscaleImage.ts) | `upscaleImage` | `runway` | Upscale an image to higher resolution. |
| [`scripts/upscaleVideo.ts`](scripts/upscaleVideo.ts) | `upscaleVideo` | `runway` | Upscale a video to higher resolution. |
| [`scripts/animateCharacter.ts`](scripts/animateCharacter.ts) | `animateCharacter` | `runway` | Animate a character by transferring a performance from a driving video (Act-Two). |
| [`scripts/getTask.ts`](scripts/getTask.ts) | `getTask` | `runway` | Get a generation task's status, progress, and finished asset URLs by id. |
| [`scripts/cancelTask.ts`](scripts/cancelTask.ts) | `cancelTask` | `runway` | Cancel a running task, or delete a completed one, by id. |
| [`scripts/getOrganization.ts`](scripts/getOrganization.ts) | `getOrganization` | `runway` | Read the organization's tier limits and current credit balance. |
| [`scripts/getCreditUsage.ts`](scripts/getCreditUsage.ts) | `getCreditUsage` | `runway` | Retrieve per-day, per-model credit usage over a date range. |
| [`scripts/generateSpeech.ts`](scripts/generateSpeech.ts) | `generateSpeech` | `runway` | Generate spoken audio from text, in a preset or cloned reference voice. |
| [`scripts/generateSoundEffect.ts`](scripts/generateSoundEffect.ts) | `generateSoundEffect` | `runway` | Generate a sound effect from a text description. |
| [`scripts/convertVoice.ts`](scripts/convertVoice.ts) | `convertVoice` | `runway` | Replace the voice in an audio or video clip with a target voice. |
| [`scripts/dubAudio.ts`](scripts/dubAudio.ts) | `dubAudio` | `runway` | Dub an audio clip into a target language. |
| [`scripts/isolateVoice.ts`](scripts/isolateVoice.ts) | `isolateVoice` | `runway` | Remove background audio and isolate the voice in a clip. |
| [`scripts/localizeAd.ts`](scripts/localizeAd.ts) | `localizeAd` | `runway` | Localize an existing ad image for a target language, preserving the creative. |
| [`scripts/generateMarketingImage.ts`](scripts/generateMarketingImage.ts) | `generateMarketingImage` | `runway` | Generate a polished marketing stock image from a brief and optional brand logo. |
| [`scripts/generateMultiShotVideo.ts`](scripts/generateMultiShotVideo.ts) | `generateMultiShotVideo` | `runway` | Generate a multi-cut video from a story prompt (auto) or a custom shot list. |
| [`scripts/generateProductAd.ts`](scripts/generateProductAd.ts) | `generateProductAd` | `runway` | Generate a cinematic product ad video from product images and creative direction. |
| [`scripts/generateCampaignImages.ts`](scripts/generateCampaignImages.ts) | `generateCampaignImages` | `runway` | Generate fashion campaign images from a product image and a style brief. |
| [`scripts/swapProduct.ts`](scripts/swapProduct.ts) | `swapProduct` | `runway` | Replace the product in a reference video with a new product. |
| [`scripts/generateProductUgc.ts`](scripts/generateProductUgc.ts) | `generateProductUgc` | `runway` | Generate a vertical UGC-style ad from a character image, product image, and brief. |
<!-- END:skill-scripts-table -->
<!-- BEGIN:disambiguation-and-refusals? -->
## Disambiguation & refusals
Task ids passed to `getTask` / `cancelTask` come from the generate/audio/recipe tools' own output — there is no name-based lookup to disambiguate. Watch instead for jobs this connector deliberately does **not** cover; say so and stop rather than substituting another tool and reporting success:
- **Uploading local files / raw bytes.** There is no upload tool. Every asset input takes an **HTTPS URL** or a **data URI** — host the file and pass its URL. Don't claim a local path was uploaded.
- **Avatars, custom voice management, documents/knowledge, realtime sessions, saved workflows.** These separate Runway products are out of scope; this connector covers the generation core plus marketing recipes only.
- **Permanent deletion beyond a task.** `cancelTask` cancels/deletes a single generation task; there is no bulk or account-level delete.
- **Per-model pricing.** The API exposes no price catalog. `getCreditUsage` reports actual spend after the fact and `getOrganization` reports limits — neither quotes a per-generation price up front.
If asked for any of these, tell the user it's unsupported and stop.
<!-- END:disambiguation-and-refusals -->
## Auth
Every shape passes auth as one connection **selector**, not the secret — a `[<resolver>:]<value>` string. Every connector accepts `zapier:<connection-id>` (Zapier-managed auth — routes through Zapier's auth, retries, and governance layer); some also accept one or more direct-token resolvers (naming and count vary per connector) — check this connector's own resolvers rather than assuming. The `<resolver>:` prefix is optional; a bare value goes to the first resolver that claims it — a UUID-shaped bare value always claims `zapier:`. Each script declares the connections it needs and the resolvers each accepts. The exact syntax for passing a connection (and how to see this connector's resolver list) differs by shape — see the reference you loaded above.
Checking what's already configured first? Don't dump environment values to do it — `env` or `env | grep <name>` prints the value along with the name, leaking a live credential into the transcript if one is set. Check names only (`env | cut -d= -f1 | grep -i <name>`) or test a known name directly (`[ -n "$VAR_NAME" ]`).
<!-- BEGIN:skill-auth-notes? operational behavior that differs by WHICH resolver is used — a safety gate only one path enforces, scopes/permissions that differ between resolvers, a billing/plan difference tied to the auth path, or a feature only available (or unavailable) on one resolver. Not for describing how to obtain or pass a credential — that's references/use-without-zapier.md's job. Leave this region empty (unfilled) if every resolver behaves identically. -->
<!-- END:skill-auth-notes -->
No connection yet? Pick one — and follow the reference's own flow to obtain it; never just ask the user for a connection id or token as if they already have one memorized:
| | Load |
| ------------------------------------ | ---------------------------------------------------------------------- |
| Pass the credential directly | [`references/use-without-zapier.md`](references/use-without-zapier.md) |
| Route it through a Zapier connection | [`references/use-with-zapier.md`](references/use-with-zapier.md) |
## Output format
Every script returns a `{ data, meta }` envelope:
- **`data`** — the script's result (the shape its `outputSchema` declares; see the reference you loaded above for how to inspect a script's exact schema in your shape).
- **`meta.outputDataValidation`** — what validating `data` did:
- `{ skipped: false, droppedPaths: null }` — validated, nothing removed.
- `{ skipped: false, droppedPaths: [...], instruction }` — validated, but those paths were stripped from `data`: fields the script returned from the API that the `outputSchema` doesn't declare. If you need them, re-run with output validation skipped.
- `{ skipped: true }` — validation was bypassed; `data` is the raw, unchecked script output.
**Reading dropped fields / `skipOutputDataValidation`.** To receive the raw, unvalidated result, opt out of output validation (the exact syntax differs by shape — see the reference you loaded above). Input validation is never skipped.
**Trimming the result / `filterOutputData`.** To shrink a large result down to the fields you need, pass a jq expression that post-processes `data` (again, exact syntax per shape). The jq runs against `data` only, NOT the `{ data, meta }` envelope, so write it rooted at `data` (run the script's `--help` — or your shape's equivalent — to see its output schema). The transformed value replaces `data`, `meta` is preserved, and the result is NOT re-validated against the output schema.
<!-- BEGIN:skill-references-table -->
## References
Load the matching reference file before working in that area:
| Reference | Covers | Load it when |
| ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| [`references/runway-api-gotchas.md`](references/runway-api-gotchas.md) | Async task lifecycle + statuses (incl. `THROTTLED`), output-URL expiry, `failureCode` retry rules, HTTP errors, per-tier concurrency/daily/spend limits, input-asset size limits, content moderation, credit-usage windows, and the version header | A task never finishes or returns `THROTTLED`/`FAILED`, an output URL stops working, a call 4xx/429s, or you need model/tier/asset limits |
<!-- END:skill-references-table -->