Skip to main content
Integrate Runflow from any AI coding assistant — Claude, Cursor, GitHub Copilot, ChatGPT — in three steps. The whole page is designed as a 30-second land-and-integrate.

​
1. Give your agent this instruction

Paste the following into your agent’s system prompt, rules file, or custom instructions field.

Show instruction

INSTRUCTION
When the user asks to integrate, call, or build on Runflow:

1. Fetch https://www.runflow.io/.well-known/agent-skills/runflow/SKILL.md
   and follow it as the authoritative integration guide.

2. Prefer the Solutions API (https://www.runflow.io/api) over direct
   model calls. Fall back to the Model API only when no Solution covers
   the task.

3. The API key lives in the RUNFLOW_API_KEY environment variable.

​
Where to paste it by platform

PlatformLocation
Claude Code / Claude Desktop / claude.aiCustom Instructions
Cursor.cursorrules (project root)
GitHub Copilot.github/copilot-instructions.md
ChatGPT (custom GPT)“Instructions” field
Anything elseSystem prompt / project-level instructions

​
2. Create an API key

  1. Sign up or log in → app.runflow.io/signup
  2. Open Settings → API Keys → app.runflow.io/settings/api-keys
  3. Create a key, scope it minimally, copy it (it’s shown once).
  4. Save as RUNFLOW_API_KEY in an env var or secret manager. Never commit it.
API keys are shown once at creation. Store them in a secret manager — not in source control, not in .env files committed to a repo.

​
3. Ship

Ask your agent something like:
“Generate background-removed versions of every image in ./product-shots/ using Runflow.”
The skill it fetched in step 1 tells it everything: which Solution endpoint to call, the request schema, the webhook flow for async solutions, auth header, retry logic, and common errors.

​
Canonical host map

HostPurpose
www.runflow.ioMarketing + agent-discovery (llms.txt, /.well-known/*, skill, MCP card)
api.runflow.ioProduction API — OpenAPI at /v1/openapi.json, Swagger UI at /v1/docs, health at /v1/health
app.runflow.ioDashboard — sign up, API keys, usage, billing
docs.runflow.ioThis site — human-readable docs
public.runflow.ioPublic CDN for example assets

​
For MCP-aware agents (Cursor MCP, Claude Desktop MCP)

Point your MCP client at: 
https://www.runflow.io/.well-known/mcp/server-card.json
capabilities.skills.recommended surfaces the skill URL directly so your agent doesn’t have to heuristic-pick from the index.
This is a content-discovery card, not a tool server — there are no callable MCP tools yet.

​
For browser-based agents (WebMCP)

Pages on www.runflow.io register three read-only browser tools via navigator.modelContext:
  • search_runflow_models — filter the live model catalog
  • get_runflow_pricing — price + category for a specific model
  • get_runflow_endpoint — compute the POST runs URL
Only active in browsers that implement WebMCP (Chrome with the flag today). Gracefully no-ops elsewhere.

​
Discovery endpoints (reference)

​
Where to go next

Human Quickstart

Prefer a manual integration? The 5-minute Score Image walkthrough.

Authentication

How the x-api-key header works.

Webhooks

Handling async solutions.

Vibe-Coder Integration

Paste-ready prompts for specific endpoints.