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

The script API from Windmill — 34 operation(s) for script.

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

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

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

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

34 operations 34 paths 11 schemas 1 DELETE23 GET10 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 script 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 34

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

script 34
GET
/scripts/hub/get/{path}
Get Hub Script Content by Path
getHubScriptContentByPath 1 param → 200
GET
/scripts/hub/get_full/{path}
Get Full Hub Script by Path
getHubScriptByPath 1 param → 200
GET
/scripts/hub/pick/{path}
Record Hub Script Pick
pickHubScriptByPath 1 param → 200
GET
/scripts/hub/top
Get Top Hub Scripts
getTopHubScripts 3 params → 200
GET
/embeddings/query_hub_scripts
Query Hub Scripts by Similarity
queryHubScripts 4 params → 200
GET
/w/{workspace}/scripts/list_search
List Scripts for Search
listSearchScript 1 param → 200
GET
/w/{workspace}/scripts/list
List All Scripts
listScripts 21 params → 200
GET
/w/{workspace}/scripts/list_paths
List All Scripts Paths
listScriptPaths 1 param → 200
POST
/w/{workspace}/scripts/create
Create Script
createScript 1 param body → 201
POST
/w/{workspace}/scripts/toggle_workspace_error_handler/p/{path}
Toggle ON and OFF the Workspace Error Handler for a Given Script
toggleWorkspaceErrorHandlerForScript 2 params body → 200
POST
/w/{workspace}/scripts/archive/p/{path}
Archive Script by Path
archiveScriptByPath 2 params → 200
POST
/w/{workspace}/scripts/archive/h/{hash}
Archive Script by Hash
archiveScriptByHash 2 params → 200
POST
/w/{workspace}/scripts/delete/h/{hash}
Delete Script by Hash (erase Content but Keep Hash, Require Admin)
deleteScriptByHash 2 params → 200
POST
/w/{workspace}/scripts/delete/p/{path}
Delete Script at a Given Path (require Admin)
deleteScriptByPath 3 params → 200
DELETE
/w/{workspace}/scripts/delete_bulk
Delete Scripts in Bulk
deleteScriptsBulk 1 param body → 200
GET
/w/{workspace}/scripts/get/p/{path}
Get Script by Path
getScriptByPath 3 params → 200
GET
/w/{workspace}/scripts/get_triggers_count/{path}
Get Triggers Count of Script
getTriggersCountOfScript 2 params → 200
GET
/w/{workspace}/scripts/list_tokens/{path}
Get Tokens with Script Scope
listTokensOfScript 2 params → 200
GET
/w/{workspace}/scripts/get/draft/{path}
Get Script by Path with Draft
getScriptByPathWithDraft 2 params → 200
GET
/w/{workspace}/scripts/history/p/{path}
Get History of a Script by Path
getScriptHistoryByPath 2 params → 200
GET
/w/{workspace}/scripts/list_paths_from_workspace_runnable/{path}
List Script Paths Using Provided Script as a Relative Import
listScriptPathsFromWorkspaceRunnable 2 params → 200
GET
/w/{workspace}/scripts/get_latest_version/{path}
Get Scripts's Latest Version (hash)
getScriptLatestVersion 2 params → 200
POST
/w/{workspace}/scripts/history_update/h/{hash}/p/{path}
Update History of a Script
updateScriptHistory 3 params body → 200
GET
/w/{workspace}/scripts/list_dedicated_with_deps
List Dedicated Worker Scripts with Workspace Dependency Annotations
listDedicatedWithDeps 1 param → 200
GET
/w/{workspace}/scripts/raw/p/{path}
Raw Script by Path
rawScriptByPath 2 params → 200
GET
/scripts_u/tokened_raw/{workspace}/{token}/{path}
raw script by path with a token (mostly used by lsp to be used with import maps to resolve scripts)
rawScriptByPathTokened 3 params → 200
GET
/w/{workspace}/scripts/exists/p/{path}
Exists Script by Path
existsScriptByPath 2 params → 200
GET
/w/{workspace}/scripts/get/h/{hash}
Get Script by Hash
getScriptByHash 4 params → 200
GET
/w/{workspace}/scripts/raw/h/{path}
Raw Script by Hash
rawScriptByHash 2 params → 200
GET
/w/{workspace}/scripts/deployment_status/h/{hash}
Get Script Deployment Status
getScriptDeploymentStatus 2 params → 200
GET
/w/{workspace}/scripts/ci_test_results/{kind}/{path}
Get CI Test Results for a Script, Flow, or Resource
getCiTestResults 3 params → 200
POST
/w/{workspace}/scripts/ci_test_results_batch
Get CI Test Results for Multiple Items
getCiTestResultsBatch 1 param body → 200
POST
/w/{workspace}/scripts/raw_temp/store
Store Raw Script Content Temporarily for CLI Lock Generation
storeRawScriptTemp 1 param body → 200
POST
/w/{workspace}/scripts/raw_temp/diff
Diff Local Script Hashes Against Deployed Versions
diffRawScriptsWithDeployed 1 param body → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are Script (45 properties), NewScript (39 properties), TriggersCount (17 properties), TruncatedToken (8 properties). Each schema is shown below with its type and property counts.

ScriptHistory
object
2 properties 1 required
Script
object
45 properties 15 required
TruncatedToken
object
8 properties 3 required
TriggersCount
object
17 properties
AssetKind
string
ScriptLang
string
HubScriptKind
string
NewScript
object
39 properties 4 required
ScriptModule
object
An additional module file associated with a script
3 properties 2 required
CiTestResult
object
4 properties 1 required
NewScriptWithDraft

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

windmill-script-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