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 Jobs API

Execution of scripts and flows - run, inspect, and cancel jobs.

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

Tagged areas include Jobs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

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

Requests are made against 2 base URLs: https://app.windmill.dev/api, http://localhost:8000/api.

7 operations 7 paths 2 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

Windmill Jobs 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.

  • bearerAuth — Bearer token created in the Windmill UI under account settings, passed as Authorization: Bearer YOURTOKEN.
  • cookieAuth — Session cookie set by the Windmill web UI after login.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Jobs 7

Execution of scripts and flows - run, inspect, and cancel jobs.

POST
/w/{workspace}/jobs/run/p/{path}
Run a script by path
runScriptByPath 2 params body → 201401
POST
/w/{workspace}/jobs/run_wait_result/p/{path}
Run a script by path and wait for the result
runScriptByPathAndWaitResult 2 params body → 200401
POST
/w/{workspace}/jobs/run/f/{path}
Run a flow by path
runFlowByPath 2 params body → 201401
GET
/w/{workspace}/jobs/list
List jobs
listJobs 1 param → 200401
GET
/w/{workspace}/jobs_u/get/{id}
Get a job
getJob 2 params → 200404
GET
/w/{workspace}/jobs_u/completed/get_result/{id}
Get a completed job result
getCompletedJobResult 2 params → 200404
POST
/w/{workspace}/jobs_u/queue/cancel/{id}
Cancel a job
cancelJob 2 params → 200404

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Job (9 properties), Error (1 property). Each schema is shown below with its type and property counts.

Job
object
9 properties
Error
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-dev-jobs-api-openapi.yml Raw ↑

Other APIs Windmill publishes across the network.

Windmill Apps API
Windmill Audit API
Windmill Flows API
Windmill Folders API
Windmill Groups API
Windmill OIDC API
Windmill Resources API
Windmill Schedules API
Windmill Scripts API
Windmill Triggers API
Windmill Users API
Windmill Variables API