Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Windmill (BYOK) — connector documentation

  • MCP endpoint: https://byok-windmill.connectorbay.com/mcp
  • REST API: POST https://byok-windmill.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-windmill.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Windmill Windmill user token, sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-windmill.connectorbay.com/health · Tool schemas: https://byok-windmill.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-windmill · agent@connectorbay.com

What Windmill (BYOK) is for

Windmill (BYOK) lets an AI assistant read your own Windmill data through the Windmill API with a key you supply (Windmill user token). Read-only: 11 tools (whoami, list_workspaces, list_scripts, list_flows, list_apps, list_schedules, list_recent_jobs, list_completed_jobs, get_job_counts, list_folders, list_variables). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to app.windmill.dev. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Windmill. Windmill and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which Windmill user is my token for?"
  • "Which Windmill workspaces can I access?"
  • "Which Python scripts are in my Windmill workspace?"
  • "What flows exist in my Windmill workspace?"
  • "Which Windmill apps do we have?"
  • "Which Windmill schedules are enabled?"

What it does

  • whoami: Show the Windmill account the token belongs to: email, username, super-admin flag and company.
  • list_workspaces: List the workspaces visible to the token with id, name, owner and domain.
  • list_scripts: List a workspace's scripts with path, summary, language, kind, author and creation time. Source code is not returned.
  • list_flows: List a workspace's flows with path, summary, last editor, edit time and starred flag. Flow definitions are not returned.
  • list_apps: List a workspace's apps with path, summary, version, execution mode and edit time.
  • list_schedules: List a workspace's schedules with cron expression, timezone, target script or flow, enabled flag and last error.
  • list_recent_jobs: List recent jobs (queued, running and completed) of a workspace with script path, kind, user, timing and success flag. Arguments, results and logs are not returned.
  • list_completed_jobs: List completed jobs of a workspace, newest first, with success flag, duration and who started them. Arguments, results and logs are not returned.
  • get_job_counts: Count the jobs waiting in the queue (and suspended) and the completed jobs stored for a workspace.
  • list_folders: List a workspace's folders with owners, summary and creator.
  • list_variables: List variable paths of a workspace with description and secret flag. Values are not returned.

BYOK key

You bring your own Windmill Windmill user token (https://app.windmill.dev/user/settings#tokens). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to app.windmill.dev over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Windmill API (app.windmill.dev) with a BYOK key; documentation: https://www.windmill.dev/docs/advanced/clients/rest_api_client. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Windmill. Windmill and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Windmill account.

Built for: Worldwide. Languages: English.