/
WI
windmill
/
Windmill API
Search skmtc…
⌘K
Changes
Docs
Sign in
Sign in
Docs
History
Schema
Filter operations
agent_workers
5
ai
9
ai_evals
14
amqp_trigger
8
app
43
asset
10
audit
2
azure_trigger
13
capture
7
concurrencyGroups
4
config
10
data_metric
1
dbt
3
documentation
2
draft
7
email_trigger
8
favorite
2
flow
21
flow_conversations
4
folder
11
gcp_trigger
14
Git Sync
13
granular_acl
3
group
19
health
2
helpers
24
http_trigger
9
hubPublish
20
indexSearch
7
input
6
integration
2
job
104
post
/w/{workspace}/jobs/list_selected_job_groups
list selected jobs script/flow schemas grouped by (kind, path)
post
/w/{workspace}/jobs/run/p/{path}
run script by path
get
/w/{workspace}/jobs/run_wait_result/p/{path}
run script by path with get
post
/w/{workspace}/jobs/run_wait_result/p/{path}
run script by path
post
/w/{workspace}/jobs/run_wait_result/f/{path}
run flow by path and wait until completion
get
/w/{workspace}/jobs/run_wait_result/fv/{version}
run flow by version with GET and wait until completion
post
/w/{workspace}/jobs/run_wait_result/fv/{version}
run flow by version and wait until completion
get
/w/{workspace}/jobs/run_and_stream/f/{path}
run flow by path with GET and stream updates via SSE
post
/w/{workspace}/jobs/run_and_stream/f/{path}
run flow by path and stream updates via SSE
get
/w/{workspace}/jobs/run_and_stream/fv/{version}
run flow by version with GET and stream updates via SSE
post
/w/{workspace}/jobs/run_and_stream/fv/{version}
run flow by version and stream updates via SSE
get
/w/{workspace}/jobs/run_and_stream/p/{path}
run script by path with GET and stream updates via SSE
post
/w/{workspace}/jobs/run_and_stream/p/{path}
run script by path and stream updates via SSE
get
/w/{workspace}/jobs/run_and_stream/h/{hash}
run script by hash with GET and stream updates via SSE
post
/w/{workspace}/jobs/run_and_stream/h/{hash}
run script by hash and stream updates via SSE
get
/w/{workspace}/jobs/result_by_id/{flow_job_id}/{node_id}
get job result by id
get
/w/{workspace}/jobs/job_view_token/{id}
mint a read-only share token for a job
get
/w/{workspace}/jobs/job_public_view_token/{id}
mint a public read-only share token for a job
post
/w/{workspace}/jobs/run/f/{path}
run flow by path
post
/w/{workspace}/jobs/run/fv/{version}
run flow by version
post
/w/{workspace}/jobs/run/batch_rerun_jobs
re-run multiple jobs
post
/w/{workspace}/jobs/restart/f/{id}
restart a completed flow at a given step
post
/w/{workspace}/jobs/run/h/{hash}
run script by hash
post
/w/{workspace}/jobs/run/preview
run script preview
post
/w/{workspace}/jobs/run_inline/preview
run script preview without starting a new job
post
/w/{workspace}/jobs/run_inline/p/{path}
run script by path without starting a new job
post
/w/{workspace}/jobs/run_inline/h/{hash}
run script by hash without starting a new job
post
/w/{workspace}/jobs/run_wait_result/preview
run script preview and wait for result
post
/w/{workspace}/jobs/workflow_as_code/{job_id}/{entrypoint}
run code-workflow task
post
/w/{workspace}/jobs/run/dependencies
run a one-off dependencies job
post
/w/{workspace}/jobs/run/dependencies_async
queue a one-off dependencies job and return the job uuid
post
/w/{workspace}/jobs/run/flow_dependencies_async
queue a one-off flow dependencies job and return the job uuid
post
/w/{workspace}/jobs/run/preview_flow
run flow preview
post
/w/{workspace}/jobs/run/agent/{path}
run a saved AI agent
post
/w/{workspace}/jobs/run_wait_result/preview_flow
run flow preview and wait for result
post
/w/{workspace}/jobs/run/dynamic_select
run dynamic select helper function
get
/w/{workspace}/jobs/queue/list
list all queued jobs
get
/w/{workspace}/jobs/queue/count
get queue count
get
/w/{workspace}/jobs/oldest
get the creation date of the oldest job
get
/w/{workspace}/jobs/completed/count
get completed count
get
/w/{workspace}/jobs/completed/count_jobs
count number of completed jobs with filter
get
/w/{workspace}/jobs/list_filtered_uuids
get the ids of all jobs matching the given filters
get
/w/{workspace}/jobs/queue/list_filtered_uuids
get the ids of all queued jobs matching the given filters
post
/w/{workspace}/jobs/queue/run_now/{id}
start a queued job scheduled for later now
post
/w/{workspace}/jobs/queue/cancel_selection
cancel jobs based on the given uuids
get
/w/{workspace}/jobs/get_otel_traces/{id}
get OpenTelemetry traces for a job
get
/w/{workspace}/jobs/completed/list
list all completed jobs
get
/w/{workspace}/jobs/completed/export
export all completed jobs for backup/migration
post
/w/{workspace}/jobs/completed/import
import completed jobs from backup/migration
get
/w/{workspace}/jobs/queue/export
export all queued jobs for backup/migration
post
/w/{workspace}/jobs/queue/import
import queued jobs from backup/migration
post
/w/{workspace}/jobs/delete
delete jobs by IDs from all related tables
get
/w/{workspace}/jobs/list
list all jobs
get
/jobs/db_clock
get db clock
get
/jobs/completed/count_by_tag
Count jobs by tag
get
/w/{workspace}/jobs_u/get/{id}
get job
get
/w/{workspace}/jobs_u/get_root_job_id/{id}
get root job id
get
/w/{workspace}/jobs/worker_is_draining/{id}
whether the worker running this job is draining
get
/w/{workspace}/jobs_u/get_logs/{id}
get job logs
get
/w/{workspace}/jobs_u/get_flow_all_logs/{id}
get all logs for a flow job
get
/w/{workspace}/jobs_u/get_flow_all_logs_structured/{id}
get all logs for a flow job in a structured format
get
/w/{workspace}/jobs_u/get_flow_all_results/{id}
get statuses and truncated results for all jobs of a flow job's execution tree
get
/w/{workspace}/jobs_u/get_completed_logs_tail/{id}
get completed job logs tail
get
/w/{workspace}/jobs_u/get_args/{id}
get job args
post
/w/{workspace}/jobs_u/queue/get_started_at_by_ids
get started at by ids
get
/w/{workspace}/jobs_u/getupdate/{id}
get job updates
get
/w/{workspace}/jobs_u/getupdate_sse/{id}
get job updates via server-sent events
get
/w/{workspace}/jobs_u/get_log_file/{path}
get log file from object store
get
/w/{workspace}/jobs_u/get_flow_debug_info/{id}
get flow debug info
get
/w/{workspace}/jobs_u/completed/get/{id}
get completed job
get
/w/{workspace}/jobs_u/completed/get_result/{id}
get completed job result
get
/w/{workspace}/jobs_u/completed/get_result_maybe/{id}
get completed job result if job is completed
get
/w/{workspace}/jobs_u/completed/get_timing/{id}
get completed job timing
get
/w/{workspace}/jobs_u/dispatch_events/{id}
list asset-trigger dispatch events for a producer job
get
/w/{workspace}/jobs/asset_dispatch_edges
list asset-cascade producer→child job edges for a folder
post
/w/{workspace}/jobs/completed/delete/{id}
delete completed job (erase content but keep run id)
post
/w/{workspace}/jobs/completed/resolve
mark failed jobs as resolved
post
/w/{workspace}/jobs/completed/unresolve
remove the resolution of failed jobs
post
/w/{workspace}/jobs_u/queue/cancel/{id}
cancel queued or running job
post
/w/{workspace}/jobs_u/queue/cancel_persistent/{path}
cancel all queued jobs for persistent script
post
/w/{workspace}/jobs_u/queue/force_cancel/{id}
force cancel queued job
get
/w/{workspace}/jobs/queue/position/{scheduled_for}
get queue position for a job
get
/w/{workspace}/jobs/queue/scheduled_for/{id}
get scheduled for timestamp for a job
get
/w/{workspace}/jobs/job_signature/{id}/{resume_id}
create an HMac signature given a job id and a resume id
get
/w/{workspace}/jobs/resume_urls/{id}/{resume_id}
get resume urls given a job_id, resume_id and a nonce to resume a flow
get
/w/{workspace}/jobs/wac_approval_urls/{id}/{step_key}
get the resume urls bound to a specific wait_for_approval step of a workflow-as-code job
get
/w/{workspace}/jobs/slack_approval/{id}
generate interactive slack approval for suspended job
get
/w/{workspace}/jobs/teams_approval/{id}
generate interactive teams approval for suspended job
post
/w/{workspace}/jobs_u/flow/resume_suspended/{job_id}
resume or cancel a suspended flow/WAC job
get
/w/{workspace}/jobs_u/flow/approval_info/{job_id}
get approval info for a suspended flow/WAC job
get
/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}
resume a job for a suspended flow
post
/w/{workspace}/jobs_u/resume/{id}/{resume_id}/{signature}
resume a job for a suspended flow
get
/w/{workspace}/jobs/flow/user_states/{id}/{key}
get flow user state at a given key
post
/w/{workspace}/jobs/flow/user_states/{id}/{key}
set flow user state at a given key
post
/w/{workspace}/jobs/flow/resume/{id}
resume a job for a suspended flow as an owner
get
/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}
cancel a job for a suspended flow
post
/w/{workspace}/jobs_u/cancel/{id}/{resume_id}/{signature}
cancel a job for a suspended flow
get
/w/{workspace}/jobs_u/get_flow/{id}/{resume_id}/{signature}
get parent flow job of suspended job
get
/w/{workspace}/jobs/dbt_resumable/{id}
Whether a dbt retry by this caller would resume this run
get
/w/{workspace}/jobs/dbt_resumable_script/p/{path}
Which run a dbt retry of this script would resume for the caller
get
/w/{workspace}/jobs/dbt_graph/{id}
Get the asset graph as one run saw it
get
/w/{workspace}/jobs/dbt_column_lineage/{id}
Get relations' project column lineage as one run saw it
get
/w/{workspace}/jobs/run_progress/{id}
List the per-relation progress one job has recorded so far
get
/w/{workspace}/jobs/run_assets/{id}
List the assets a run touched at runtime
kafka_trigger
10
mcp
1
mcp_oauth
3
metrics
3
mqtt_trigger
8
native_trigger
14
nats_trigger
8
npm_proxy
6
oauth
13
oidc
1
openapi
2
path_autocomplete
1
postgres_trigger
20
raw_app
1
resource
31
schedule
10
script
37
service_logs
2
setting
62
settings
4
sqs_trigger
8
teams
1
token
1
trash
5
trigger
3
user
65
variable
10
volume
4
websocket_trigger
8
worker
13
workspace
142
workspace_dependencies
5
workspace_integration
8
job
Copy Markdown
Copied
Copy failed
Changes to whether the worker running this job is draining
get
/w/{workspace}/jobs/worker_is_draining/{id}
Oct 8, 2026
eb2dac2825be
Revision changes
info
endpoint added