---
title: API Reference
description: Execute workflows, manage executions, and integrate Wireflow into your stack via a REST API.
updated: 2026-10-17
---

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](/docs/api/overview). architecture, pagination, idempotency
- [Route index](/docs/api/routes): every public API operation
- [Authentication](/docs/api/authentication). API keys, scopes, rotation
- [Workflows](/docs/api/workflows). list, get, create, update, delete
- [Nodes](/docs/api/nodes). the node catalog: ports, config keys, enum options, defaults, pricing. The source of truth for building graphs
- [Templates](/docs/api/templates). discover published templates (metadata + input interface, never the graph)
- [Execute Templates](/docs/api/templates-execute). run a template by reference on your own credits
- [Video Compositions](/docs/api/remotion-templates) (what a Video Editor node expects: template `inputMappings` and the sceneGraph authoring contract)
- [Run](/docs/api/run). trigger an execution
- [Executions](/docs/api/executions). poll status, fetch outputs, list history
- [Apps API](/docs/api/apps): call a published app with an API key; the caller pays
- [Social Accounts](/docs/api/social): list the social accounts connected to your login, to point a Social Publish node at them
- [Webhooks](/docs/api/webhooks): get a signed POST when a run finishes, instead of polling
- [Publishing](/docs/api/publishing). publish a workflow as a branded app
- [Rate limits](/docs/api/rate-limits). enforced limits and retry headers
- [Errors](/docs/api/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.

```bash
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](/docs/api/run#complete-example).

## Discovery

- **OpenAPI spec:** [`/openapi.json`](https://www.wireflow.ai/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`](https://www.wireflow.ai/.well-known/api-catalog) (RFC 9727 linkset)
- **MCP discovery:** [`/.well-known/mcp.json`](https://www.wireflow.ai/.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`](https://www.wireflow.ai/.well-known/ai-catalog.json)
- **Agent skills index:** [`/.well-known/agent-skills/index.json`](https://www.wireflow.ai/.well-known/agent-skills/index.json) (Agent Skills RFC v0.2.0)
- **MCP server card:** [`/.well-known/mcp/server-card.json`](https://www.wireflow.ai/.well-known/mcp/server-card.json). see [MCP integration](/docs/mcp)
- **Public node catalog:** [`GET /api/v1/nodes`](https://www.wireflow.ai/api/v1/nodes). unauthenticated, every wireable node with ports, config keys, enums, and pricing. Use this to build graphs; [docs](/docs/api/nodes)
- **Public model catalog:** [`GET /api/v1/models`](https://www.wireflow.ai/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](/docs/mcp) is the packaged client.

## Support

- Email: [support@wireflow.ai](mailto:support@wireflow.ai)
- Discord: [discord.com/invite/KGatnxrETG](https://discord.com/invite/KGatnxrETG)

Last updated: 2026-10-17

---

Documentation index: fetch https://www.wireflow.ai/llms.txt for the full list of Wireflow docs.