windmill-api

library1.719.0pypypi✓ verified 81d ago

A client library for accessing the Windmill API. Windmill is a self-hostable, open-source platform to build internal tools and workflows with Python and TypeScript. The API client auto-generates Python bindings for all Windmill endpoints. Current version: 1.719.0. Release cadence: frequent (multiple per week).

devops

pip install windmill-api

INSTALL

IMPORT

SIG · WINDMILL-API

windmill-api

devopspythonv1.719.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

Client

✓ from windmill_api import Client

✗ from windmill_api import WindmillApiClient

AuthenticatedClient

✓ from windmill_api import AuthenticatedClient

Initialize client with base URL and token, then call an endpoint.

import os from windmill_api import WindmillApiClient client = WindmillApiClient( base_url=os.environ.get("WINDMILL_BASE_URL", "http://localhost:8000"), token=os.environ.get("WINDMILL_TOKEN", ""), ) # List users users = client.list_users() print(users)

Debug

Known issues

breakingThe client constructor no longer accepts `api_key` parameter; use `token` instead.

fix

Replace `api_key='...'` with `token='...'`.

affects: >=1.350.0

breakingSynchronous client methods now return Pydantic models instead of dictionaries. Access fields as attributes, not keys.

fix

Change `user['id']` to `user.id`.

affects: >=1.500.0

gotchaThe client does not automatically refresh expired tokens. You need to handle token rotation yourself.

fix

Monitor token expiry and recreate the client with a new token.

affects: all

gotchaSome endpoints (e.g., run script) are asynchronous and return a job ID; you must poll for completion separately.

fix

Call `client.get_result(job_id)` after submission.

affects: all

Upgrade

Version history

1.719.0latest on PyPI · released Jun 6, 2026

Audit

Dependencies

httpxrequiredHTTP client for API requests

pydanticrequiredData validation and serialization

Agent activity

12 hits · last 30 days

node

Resources

No resource links recorded.