Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Windmill flow API

The flow API from Windmill — 21 operation(s) for flow.

Windmill flow API is one of 59 APIs that Windmill publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include flow. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 21 operations across 21 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.694.0.

Requests are made against a single base URL, /api.

21 operations 21 paths 7 schemas 1 DELETE15 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.694.0
Base URL
https://app.windmill.dev/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Windmill flow API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the cookie as token (cookieAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 21 paths, the API surfaces 21 operations — 1 DELETE, 15 GET, 5 POST. Each is listed below with its method, path, parameters, and response codes.

flow 21
GET
/flows/hub/list
List All Hub Flows
listHubFlows → 200
GET
/flows/hub/get/{id}
Get Hub Flow by Id
getHubFlowById 1 param → 200
GET
/w/{workspace}/flows/list_paths
List All Flow Paths
listFlowPaths 1 param → 200
GET
/w/{workspace}/flows/list_search
List Flows for Search
listSearchFlow 1 param → 200
GET
/w/{workspace}/flows/list
List All Flows
listFlows 14 params → 200
GET
/w/{workspace}/flows/history/p/{path}
Get Flow History by Path
getFlowHistory 2 params → 200
GET
/w/{workspace}/flows/get_latest_version/{path}
Get Flow's Latest Version
getFlowLatestVersion 2 params → 200
GET
/w/{workspace}/flows/list_paths_from_workspace_runnable/{runnable_kind}/{path}
List Flow Paths from Workspace Runnable
listFlowPathsFromWorkspaceRunnable 4 params → 200
GET
/w/{workspace}/flows/get/v/{version}
Get Flow Version
getFlowVersion 2 params → 200
POST
/w/{workspace}/flows/history_update/v/{version}
Update Flow History
updateFlowHistory 2 params body → 200
GET
/w/{workspace}/flows/get/{path}
Get Flow by Path
getFlowByPath 3 params → 200
GET
/w/{workspace}/flows/deployment_status/p/{path}
Get Flow Deployment Status
getFlowDeploymentStatus 2 params → 200
GET
/w/{workspace}/flows/get_triggers_count/{path}
Get Triggers Count of Flow
getTriggersCountOfFlow 2 params → 200
GET
/w/{workspace}/flows/list_tokens/{path}
Get Tokens with Flow Scope
listTokensOfFlow 2 params → 200
POST
/w/{workspace}/flows/toggle_workspace_error_handler/{path}
Toggle ON and OFF the Workspace Error Handler for a Given Flow
toggleWorkspaceErrorHandlerForFlow 2 params body → 200
GET
/w/{workspace}/flows/get/draft/{path}
Get Flow by Path with Draft
getFlowByPathWithDraft 2 params → 200
GET
/w/{workspace}/flows/exists/{path}
Exists Flow by Path
existsFlowByPath 2 params → 200
POST
/w/{workspace}/flows/create
Create Flow
createFlow 1 param body → 201
POST
/w/{workspace}/flows/update/{path}
Update Flow
updateFlow 2 params body → 200
POST
/w/{workspace}/flows/archive/{path}
Archive Flow by Path
archiveFlowByPath 2 params body → 200
DELETE
/w/{workspace}/flows/delete/{path}
Delete Flow by Path
deleteFlowByPath 3 params → 200

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are TriggersCount (17 properties), FlowMetadata (16 properties), TruncatedToken (8 properties), FlowVersion (3 properties). Each schema is shown below with its type and property counts.

ExtraPerms
object
Flow
FlowMetadata
object
16 properties 5 required
TruncatedToken
object
8 properties 3 required
TriggersCount
object
17 properties
OpenFlowWPath
FlowVersion
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-flow-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill admin API
Windmill agent_workers API
Windmill app API
Windmill asset API
Windmill audit API
Windmill azure_trigger API
Windmill capture API
Windmill concurrencyGroups API
Windmill config API
Windmill documentation API
Windmill draft API
Windmill email_trigger API