Windmill

Windmill Script API

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

GitHub OpenAPI

Operations 34

GET /scripts/hub/get/{path} Get Hub Script Content by Path #
GET /scripts/hub/get_full/{path} Get Full Hub Script by Path #
GET /scripts/hub/pick/{path} Record Hub Script Pick #
GET /scripts/hub/top Get Top Hub Scripts #
GET /embeddings/query_hub_scripts Query Hub Scripts by Similarity #
GET /w/{workspace}/scripts/list_search List Scripts for Search #
GET /w/{workspace}/scripts/list List All Scripts #
GET /w/{workspace}/scripts/list_paths List All Scripts Paths #
POST /w/{workspace}/scripts/create Create Script #
POST /w/{workspace}/scripts/toggle_workspace_error_handler/p/{path} Toggle ON and OFF the Workspace Error Handler for a Given Script #
POST /w/{workspace}/scripts/archive/p/{path} Archive Script by Path #
POST /w/{workspace}/scripts/archive/h/{hash} Archive Script by Hash #
POST /w/{workspace}/scripts/delete/h/{hash} Delete Script by Hash (erase Content but Keep Hash, Require Admin) #
POST /w/{workspace}/scripts/delete/p/{path} Delete Script at a Given Path (require Admin) #
DELETE /w/{workspace}/scripts/delete_bulk Delete Scripts in Bulk #
GET /w/{workspace}/scripts/get/p/{path} Get Script by Path #
GET /w/{workspace}/scripts/get_triggers_count/{path} Get Triggers Count of Script #
GET /w/{workspace}/scripts/list_tokens/{path} Get Tokens with Script Scope #
GET /w/{workspace}/scripts/get/draft/{path} Get Script by Path with Draft #
GET /w/{workspace}/scripts/history/p/{path} Get History of a Script by Path #
GET /w/{workspace}/scripts/list_paths_from_workspace_runnable/{path} List Script Paths Using Provided Script as a Relative Import #
GET /w/{workspace}/scripts/get_latest_version/{path} Get Scripts's Latest Version (hash) #
POST /w/{workspace}/scripts/history_update/h/{hash}/p/{path} Update History of a Script #
GET /w/{workspace}/scripts/list_dedicated_with_deps List Dedicated Worker Scripts with Workspace Dependency Annotations #
GET /w/{workspace}/scripts/raw/p/{path} Raw Script by Path #
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… #
GET /w/{workspace}/scripts/exists/p/{path} Exists Script by Path #
GET /w/{workspace}/scripts/get/h/{hash} Get Script by Hash #
GET /w/{workspace}/scripts/raw/h/{path} Raw Script by Hash #
GET /w/{workspace}/scripts/deployment_status/h/{hash} Get Script Deployment Status #
GET /w/{workspace}/scripts/ci_test_results/{kind}/{path} Get CI Test Results for a Script, Flow, or Resource #
POST /w/{workspace}/scripts/ci_test_results_batch Get CI Test Results for Multiple Items #
POST /w/{workspace}/scripts/raw_temp/store Store Raw Script Content Temporarily for CLI Lock Generation #
POST /w/{workspace}/scripts/raw_temp/diff Diff Local Script Hashes Against Deployed Versions #

Documentation

📖
Documentation
https://www.windmill.dev/docs/intro
📖
GettingStarted
https://www.windmill.dev/docs/getting_started/how_to_use_windmill
📖
Authentication
https://www.windmill.dev/docs/core_concepts/authentification

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-script-api-openapi.yml

Other Resources

🔗
APIReferenceDocumentation
https://app.windmill.dev/openapi.html
🔗
HTTPRoutes
https://www.windmill.dev/docs/core_concepts/http_routing
🔗
CLI
https://www.windmill.dev/docs/advanced/cli
🔗
SelfHosting
https://www.windmill.dev/docs/advanced/self_host
🔗
TypeScriptSDK
https://www.windmill.dev/docs/advanced/clients/ts_client
🔗
PythonSDK
https://www.windmill.dev/docs/advanced/clients/python_client
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/rules/windmill-api-rules.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/windmill-script-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

windmill-script-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill Script API
  contact:
    name: Windmill Team
    email: contact@windmill.dev
    url: https://windmill.dev
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: https://windmill.dev/img/windmill.svg
servers:
- url: /api
security:
- bearerAuth: []
- cookieAuth: []
tags:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/windmill/refs/heads/main/openapi/windmill-script-api-openapi.yml