Check Compatibility
Analyze the user's project to determine whether it is compatible with Runway's public API.
Why This Matters
Runway's public API requires server-side invocation. The API key must never be exposed in client-side code. Projects that are purely frontend (static HTML/JS, client-only SPAs without a backend) cannot safely call the API.
Analysis Steps
Step 1: Identify the Project Type
Search the project root for these files to determine the stack:
| File |
Indicates |
package.json |
Node.js project |
requirements.txt, pyproject.toml, Pipfile, setup.py |
Python project |
go.mod |
Go project |
Cargo.toml |
Rust project |
pom.xml, build.gradle |
Java/Kotlin project |
Gemfile |
Ruby project |
composer.json |
PHP project |
If none of these exist, flag the project as unknown and ask the user what language/runtime they're using.
Step 2: Check for Server-Side Capability
Look for indicators of a server/backend:
Node.js projects — check package.json dependencies for:
express, fastify, koa, hapi, nest, hono → HTTP server framework
next → Next.js (has API routes — compatible)
nuxt → Nuxt.js (has server routes — compatible)
remix → Remix (has loaders/actions — compatible)
@sveltejs/kit → SvelteKit (has server routes — compatible)
astro → Astro (has API endpoints if SSR enabled)
Python projects — check for:
flask, django, fastapi, starlette, tornado, aiohttp, sanic → web server framework
streamlit, gradio → can make server-side calls
Red flags (frontend-only):
package.json with only react, vue, svelte, angular and NO server framework
vite.config.ts or webpack.config.js with no server/SSR configuration
- Static site generators without server routes (e.g., plain Gatsby, plain Eleventy)
index.html as the only entry point with inline <script> tags
Step 3: Check for Existing Runway SDK
Search for existing Runway SDK installations:
Node.js:
- Check
package.json for @runwayml/sdk
- Search for
import RunwayML or require('@runwayml/sdk') in source files
Python:
- Check
requirements.txt / pyproject.toml for runwayml
- Search for
from runwayml import RunwayML or import runwayml in source files
Step 4: Check Runtime Version
Node.js: Must be version 18 or higher (node --version)
Python: Must be version 3.8 or higher (python3 --version)
Step 5: Check for Environment Variable Support
Look for .env file, .env.example, .env.local, or dotenv configuration:
- Node.js:
dotenv in dependencies, or framework-native env support (Next.js, etc.)
- Python:
python-dotenv in dependencies, or framework-native support
Report Format
After analysis, provide a clear report:
## Runway API Compatibility Report
**Project type:** [Node.js / Python / etc.]
**Server-side capable:** [Yes / No / Partial]
**Runtime version:** [version] — [Compatible / Needs upgrade]
**Runway SDK installed:** [Yes / No]
**Environment variable support:** [Yes / No / Needs setup]
### Verdict: [COMPATIBLE / NEEDS CHANGES / INCOMPATIBLE]
[If COMPATIBLE]
Your project is ready for Runway API integration. Proceed with API key setup.
[If NEEDS CHANGES]
Your project needs the following changes:
1. [List specific changes needed]
[If INCOMPATIBLE]
Your project is frontend-only and cannot safely call Runway's API. Options:
1. **Add a backend** — Add an Express/FastAPI server or use a framework with server routes (Next.js, SvelteKit, etc.)
2. **Use a serverless function** — Add API routes via Vercel Functions, AWS Lambda, Cloudflare Workers, etc.
3. **Create a separate backend** — Build a thin API proxy that your frontend calls
Important Notes
- Never suggest embedding the API key in client-side code. This is a security risk.
- If the project uses Next.js, Remix, SvelteKit, Nuxt, or Astro with SSR, it IS compatible — the server-side route handlers can call the API.
- Serverless platforms (Vercel, Netlify, AWS Lambda, Cloudflare Workers) are compatible.
- Docker/containerized apps are compatible if they run a server process.
After Compatibility Check
If the project is compatible, suggest the user proceed with +setup-api-key to configure their API credentials.
1---2name: check-compatibility3description: "Analyze a user's codebase to verify it can use Runway's public API (server-side requirement)"4user-invocable: false5allowed-tools: Read, Grep, Glob, Bash(node --version), Bash(python3 --version), Bash(pip show *), Bash(npm ls *)6metadata:7 source: https://skillmd.com/skills/bishal-pdmsft/check-compatibility8---910# Check Compatibility1112Analyze the user's project to determine whether it is compatible with Runway's public API.1314## Why This Matters1516Runway's public API **requires server-side invocation**. The API key must never be exposed in client-side code. Projects that are purely frontend (static HTML/JS, client-only SPAs without a backend) cannot safely call the API.1718## Analysis Steps1920### Step 1: Identify the Project Type2122Search the project root for these files to determine the stack:2324| File | Indicates |25|------|-----------|26| `package.json` | Node.js project |27| `requirements.txt`, `pyproject.toml`, `Pipfile`, `setup.py` | Python project |28| `go.mod` | Go project |29| `Cargo.toml` | Rust project |30| `pom.xml`, `build.gradle` | Java/Kotlin project |31| `Gemfile` | Ruby project |32| `composer.json` | PHP project |3334If none of these exist, flag the project as **unknown** and ask the user what language/runtime they're using.3536### Step 2: Check for Server-Side Capability3738Look for indicators of a server/backend:3940**Node.js projects — check `package.json` dependencies for:**41- `express`, `fastify`, `koa`, `hapi`, `nest`, `hono` → HTTP server framework42- `next` → Next.js (has API routes — compatible)43- `nuxt` → Nuxt.js (has server routes — compatible)44- `remix` → Remix (has loaders/actions — compatible)45- `@sveltejs/kit` → SvelteKit (has server routes — compatible)46- `astro` → Astro (has API endpoints if SSR enabled)4748**Python projects — check for:**49- `flask`, `django`, `fastapi`, `starlette`, `tornado`, `aiohttp`, `sanic` → web server framework50- `streamlit`, `gradio` → can make server-side calls5152**Red flags (frontend-only):**53- `package.json` with only `react`, `vue`, `svelte`, `angular` and NO server framework54- `vite.config.ts` or `webpack.config.js` with no server/SSR configuration55- Static site generators without server routes (e.g., plain Gatsby, plain Eleventy)56- `index.html` as the only entry point with inline `<script>` tags5758### Step 3: Check for Existing Runway SDK5960Search for existing Runway SDK installations:6162**Node.js:**63- Check `package.json` for `@runwayml/sdk`64- Search for `import RunwayML` or `require('@runwayml/sdk')` in source files6566**Python:**67- Check `requirements.txt` / `pyproject.toml` for `runwayml`68- Search for `from runwayml import RunwayML` or `import runwayml` in source files6970### Step 4: Check Runtime Version7172**Node.js:** Must be version 18 or higher (`node --version`)73**Python:** Must be version 3.8 or higher (`python3 --version`)7475### Step 5: Check for Environment Variable Support7677Look for `.env` file, `.env.example`, `.env.local`, or dotenv configuration:78- Node.js: `dotenv` in dependencies, or framework-native env support (Next.js, etc.)79- Python: `python-dotenv` in dependencies, or framework-native support8081## Report Format8283After analysis, provide a clear report:8485```86## Runway API Compatibility Report8788**Project type:** [Node.js / Python / etc.]89**Server-side capable:** [Yes / No / Partial]90**Runtime version:** [version] — [Compatible / Needs upgrade]91**Runway SDK installed:** [Yes / No]92**Environment variable support:** [Yes / No / Needs setup]9394### Verdict: [COMPATIBLE / NEEDS CHANGES / INCOMPATIBLE]9596[If COMPATIBLE]97Your project is ready for Runway API integration. Proceed with API key setup.9899[If NEEDS CHANGES]100Your project needs the following changes:1011. [List specific changes needed]102103[If INCOMPATIBLE]104Your project is frontend-only and cannot safely call Runway's API. Options:1051. **Add a backend** — Add an Express/FastAPI server or use a framework with server routes (Next.js, SvelteKit, etc.)1062. **Use a serverless function** — Add API routes via Vercel Functions, AWS Lambda, Cloudflare Workers, etc.1073. **Create a separate backend** — Build a thin API proxy that your frontend calls108```109110## Important Notes111112- **Never suggest embedding the API key in client-side code.** This is a security risk.113- If the project uses Next.js, Remix, SvelteKit, Nuxt, or Astro with SSR, it IS compatible — the server-side route handlers can call the API.114- Serverless platforms (Vercel, Netlify, AWS Lambda, Cloudflare Workers) are compatible.115- Docker/containerized apps are compatible if they run a server process.116117## After Compatibility Check118119If the project is compatible, suggest the user proceed with `+setup-api-key` to configure their API credentials.