Overview

Build and run Blitflow workflows from code — HTTP API, TypeScript SDK, and MCP server.

Blitflow runs AI workflows: graphs of nodes (image models, LLMs, media utilities) that turn inputs into generated outputs. You can design workflows visually in the Studio editor, or build them dynamically in code — and run either kind programmatically.

Three ways in, one contract

Every operation is defined once in the Blitflow API contract. The HTTP API, the TypeScript SDK, and the MCP server are all derived from the same contract, so they expose the same five operations with identical inputs and outputs:

Operation	HTTP	SDK	MCP tool
`nodes.list`	`GET /v1/nodes`	`searchNodes(client, …)`	`nodes_list`
`nodes.get`	`GET /v1/nodes/:id`	`getNode(client, id)`	`nodes_get`
`runs.create`	`POST /v1/runs`	`run(…)` / `startRun(…)`	`runs_create`
`workflows.get`	`GET /v1/workflows/:id`	`getWorkflow(client, ref)`	`workflows_get`
`runs.node`	`POST /v1/runs/node`	`client.ops["runs.node"](…)`	`runs_node`

Pick the surface that fits:

Surface	You are…	Reach for it when
HTTP API	any language, any runtime	you want plain REST + SSE with a bearer token
SDK (`@blitflow/sdk`)	a TypeScript app	you're building a product on top of Blitflow
MCP	an AI agent / assistant (Claude, Cursor)	you want a model to call Blitflow as a tool
CLI (`blitflow`)	a person in a terminal / CI	you're scripting or experimenting

HTTP API

Plain REST + Server-Sent Events. Use it from any language with a bearer token.

TypeScript SDK

Typed client, workflow builder, and streaming helpers for Node.js, Bun, and the browser.

MCP server

Let AI agents (Claude, Cursor, …) discover nodes and run workflows as tools.

Prefer learning by task? The Guides show the same task on every surface, side by side.

Two ways to get a workflow

Reference a published workflow. Design it in the Studio editor, publish a version, and run it by reference — <workflowId>@<version> such as abc123@2.1.0 or abc123@latest. See Versioning.
Send an inline definition. Build the workflow JSON in code (by hand or with the SDK builder) and pass it directly to a run — no publishing step required.

Where to start

Quickstart

Create a token and run your first workflow in a few minutes.

Workflow definitions

The JSON shape of a workflow: nodes, refs, inputs, and outputs.

Runs & streaming

Run lifecycle, streamed events, and cost control.

Authentication

Personal access tokens, device login, and scopes.

For AI agents

These docs are machine-readable: append .md to any page URL for clean Markdown, or fetch /llms.txt (an index of every page) and /llms-full.txt (the full text of all pages).