/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 53m ago · Updated 6h ago
View markdown
windmill
Windmill API
post
run a one-off dependencies job
latest
OpenAPI 3.0.3
Apache 2.0
raw.githubusercontent.com
2026-08-17
826
354
1004.6 KB
063a4e2b46d8
agent_workers
5
amqp_trigger
8
app
41
asset
9
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
5
email_trigger
8
favorite
2
flow
20
flow_conversations
3
folder
11
gcp_trigger
11
Git Sync
10
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
17
indexSearch
7
input
6
integration
1
job
98
post
list selected jobs script/flow schemas grouped by (kind, path)
post
run script by path
get
run script by path with get
post
run script by path
post
run flow by path and wait until completion
get
run flow by version with GET and wait until completion
post
run flow by version and wait until completion
get
run flow by path with GET and stream updates via SSE
post
run flow by path and stream updates via SSE
get
run flow by version with GET and stream updates via SSE
post
run flow by version and stream updates via SSE
get
run script by path with GET and stream updates via SSE
post
run script by path and stream updates via SSE
get
run script by hash with GET and stream updates via SSE
post
run script by hash and stream updates via SSE
get
get job result by id
get
mint a read-only share token for a job
get
mint a public read-only share token for a job
post
run flow by path
post
run flow by version
post
re-run multiple jobs
post
restart a completed flow at a given step
post
run script by hash
post
run script preview
post
run script preview without starting a new job
post
run script by path without starting a new job
post
run script by hash without starting a new job
post
run script preview and wait for result
post
run code-workflow task
post
run a one-off dependencies job
post
queue a one-off dependencies job and return the job uuid
post
queue a one-off flow dependencies job and return the job uuid
post
run flow preview
post
run flow preview and wait for result
post
run dynamic select helper function
get
list all queued jobs
get
get queue count
get
get completed count
get
count number of completed jobs with filter
get
get the ids of all jobs matching the given filters
get
get the ids of all queued jobs matching the given filters
post
cancel jobs based on the given uuids
get
get OpenTelemetry traces for a job
get
list all completed jobs
get
export all completed jobs for backup/migration
post
import completed jobs from backup/migration
get
export all queued jobs for backup/migration
post
import queued jobs from backup/migration
post
delete jobs by IDs from all related tables
get
list all jobs
get
get db clock
get
Count jobs by tag
get
get job
get
get root job id
get
get job logs
get
get all logs for a flow job
get
get all logs for a flow job in a structured format
get
get statuses and truncated results for all jobs of a flow job's execution tree
get
get completed job logs tail
get
get job args
post
get started at by ids
get
get job updates
get
get job updates via server-sent events
get
get log file from object store
get
get flow debug info
get
get completed job
get
get completed job result
get
get completed job result if job is completed
get
get completed job timing
get
list asset-trigger dispatch events for a producer job
get
list asset-cascade producer→child job edges for a folder
post
delete completed job (erase content but keep run id)
post
mark failed jobs as resolved
post
remove the resolution of failed jobs
post
cancel queued or running job
post
cancel all queued jobs for persistent script
post
force cancel queued job
get
get queue position for a job
get
get scheduled for timestamp for a job
get
create an HMac signature given a job id and a resume id
get
get resume urls given a job_id, resume_id and a nonce to resume a flow
get
get the resume urls bound to a specific wait_for_approval step of a workflow-as-code job
get
generate interactive slack approval for suspended job
get
generate interactive teams approval for suspended job
post
resume or cancel a suspended flow/WAC job
get
get approval info for a suspended flow/WAC job
get
resume a job for a suspended flow
post
resume a job for a suspended flow
get
get flow user state at a given key
post
set flow user state at a given key
post
resume a job for a suspended flow as an owner
get
cancel a job for a suspended flow
post
cancel a job for a suspended flow
get
get parent flow job of suspended job
get
Whether a dbt retry by this caller would resume this run
get
Which run a dbt retry of this script would resume for the caller
get
Get the asset graph as one run saw it
get
List the per-relation progress one job has recorded so far
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
13
nats_trigger
8
npm_proxy
6
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
28
schedule
10
script
36
service_logs
2
setting
52
settings
4
sqs_trigger
8
teams
1
token
1
trigger
3
user
57
variable
10
volume
4
websocket_trigger
8
worker
10
workspace
128
workspace_dependencies
5
workspace_integration
8
job
run a one-off dependencies job
post
/w/{workspace}/jobs/run/dependencies
Path parameters
workspace
string
required
Request body
object
required
raw_scripts
RawScriptForDependencies[]
required
entrypoint
string
required
Response
dependency job result
object
required
lock
string
required