API Reference | Wireflow Docs

The Wireflow API lets you execute AI workflows programmatically, poll for results, and manage resources using standard REST calls with Bearer-token authentication.

Base URL

https://www.wireflow.ai/api/v1

Section index

Overview. architecture, pagination, idempotency
Route index: every public API operation
Authentication. API keys, scopes, rotation
Workflows. list, get, create, update, delete
Nodes. the node catalog: ports, config keys, enum options, defaults, pricing. The source of truth for building graphs
Templates. discover published templates (metadata + input interface, never the graph)
Execute Templates. run a template by reference on your own credits
Video Compositions (what a Video Editor node expects: template inputMappings and the sceneGraph authoring contract)
Run. trigger an execution
Executions. poll status, fetch outputs, list history
Apps API: call a published app with an API key; the caller pays
Social Accounts: list the social accounts connected to your login, to point a Social Publish node at them
Webhooks: get a signed POST when a run finishes, instead of polling
Publishing. publish a workflow as a branded app
Rate limits. enforced limits and retry headers
Errors. error codes and recovery patterns

Quick start

Use a saved workflow you own and a key with workflows:execute and executions:read. Read its input schema first and copy the returned key for each value you want to replace.

curl https://www.wireflow.ai/api/v1/workflows/YOUR_WORKFLOW_ID/run \
  -H "Authorization: Bearer sk-your-api-key"

# Start with saved input values, or add inputs using the keys above.
curl -X POST https://www.wireflow.ai/api/v1/workflows/YOUR_WORKFLOW_ID/run \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json" \
  -d '{}'

# 202: {"data":{"executionId":"exec_456","status":"running",
#               "poll":"/api/v1/workflows/executions/exec_456/poll"}}
# Resolve data.poll against https://www.wireflow.ai, then GET that URL.
curl https://www.wireflow.ai/api/v1/workflows/executions/exec_456/poll \
  -H "Authorization: Bearer sk-your-api-key"

Stop on COMPLETED, FAILED, CANCELLED or TIMEOUT when returned. Put a deadline on polling. Completed owner reads expose result, nodes and nodeStates; cross-account reads expose outputs. See the complete run example.

Discovery

OpenAPI spec: /openapi.json. OpenAPI 3.1, every public operation with Bearer auth and the 402 and 429 error shapes. Import it into Postman, a GPT Action or any OpenAPI client. Also linked from /.well-known/api-catalog (RFC 9727 linkset)
MCP discovery: /.well-known/mcp.json. the MCP Server Card (SEP-2127): remote endpoint, transport, OAuth metadata, the same values as the official MCP registry entry io.github.wireflowINC/wireflow. Listed by the AI catalog at /.well-known/ai-catalog.json
Agent skills index: /.well-known/agent-skills/index.json (Agent Skills RFC v0.2.0)
MCP server card: /.well-known/mcp/server-card.json. see MCP integration
Public node catalog: GET /api/v1/nodes. unauthenticated, every wireable node with ports, config keys, enums, and pricing. Use this to build graphs; docs
Public model catalog: GET /api/v1/models. unauthenticated, returns every model with credit cost. For building graphs use /nodes
Identity check: GET /api/v1/me. which account your API key acts as (userId, email, plan). Call it before writes when running multiple keys or agents

Client libraries

There is no official SDK. Any HTTP client works: most integrations use Bearer-token auth and JSON request/response bodies. For agents, the MCP server is the packaged client.

Support

Email: support@wireflow.ai
Discord: discord.com/invite/KGatnxrETG