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

The helpers API from Windmill — 22 operation(s) for helpers.

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

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

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

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

22 operations 22 paths 5 schemas 1 DELETE14 GET7 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 helpers 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 22

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

helpers 22
POST
/w/{workspace}/job_helpers/duckdb_connection_settings
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
duckdbConnectionSettings 1 param body → 200
POST
/w/{workspace}/job_helpers/v2/duckdb_connection_settings
Converts an S3 resource to the set of instructions necessary to connect DuckDB to an S3 bucket
duckdbConnectionSettingsV2 1 param body → 200
POST
/w/{workspace}/job_helpers/polars_connection_settings
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
polarsConnectionSettings 1 param body → 200
POST
/w/{workspace}/job_helpers/v2/polars_connection_settings
Converts an S3 resource to the set of arguments necessary to connect Polars to an S3 bucket
polarsConnectionSettingsV2 1 param body → 200
POST
/w/{workspace}/job_helpers/v2/s3_resource_info
Returns the S3 Resource Associated to the Provided Path, or the workspace default S3 resource
s3ResourceInfo 1 param body → 200
GET
/w/{workspace}/job_helpers/test_connection
Test Connection to the Workspace Object Storage
datasetStorageTestConnection 2 params → 200
GET
/w/{workspace}/job_helpers/list_stored_files
List the File Keys Available in a Workspace Object Storage
listStoredFiles 5 params → 200
GET
/w/{workspace}/job_helpers/load_file_metadata
Load Metadata of the File
loadFileMetadata 3 params → 200
GET
/w/{workspace}/job_helpers/load_file_preview
Load a Preview of the File
loadFilePreview 9 params → 200
GET
/w/{workspace}/job_helpers/list_git_repo_files
List the File Keys Available in Instance Object Storage with Resource-based Access Control
listGitRepoFiles 5 params → 200
GET
/w/{workspace}/job_helpers/load_git_repo_file_preview
Load a Preview of a File from Instance Storage with Resource-based Access Control
loadGitRepoFilePreview 9 params → 200
GET
/w/{workspace}/job_helpers/load_git_repo_file_metadata
Load File Metadata from Instance Storage with Resource-based Access Control
loadGitRepoFileMetadata 3 params → 200
GET
/w/{workspace}/job_helpers/check_s3_folder_exists
Check if S3 Path Exists and is a Folder
checkS3FolderExists 3 params → 200
GET
/w/{workspace}/job_helpers/load_parquet_preview/{path}
Load a Preview of a Parquet File
loadParquetPreview 9 params → 200
GET
/w/{workspace}/job_helpers/load_table_count/{path}
Load the Table Row Count
loadTableRowCount 5 params → 200
GET
/w/{workspace}/job_helpers/load_csv_preview/{path}
Load a Preview of a Csv File
loadCsvPreview 10 params → 200
DELETE
/w/{workspace}/job_helpers/delete_s3_file
Permanently Delete File from S3
deleteS3File 3 params → 200
GET
/w/{workspace}/job_helpers/move_s3_file
Move a S3 File from One Path to the Other Within the Same Bucket
moveS3File 4 params → 200
POST
/w/{workspace}/job_helpers/upload_s3_file
Upload File to S3 Bucket
fileUpload 8 params body → 200
POST
/w/{workspace}/job_helpers/upload_git_repo_file_to_instance_storage
Upload a File to the Instance Storage Gitrepos Section for Viewing
gitRepoViewerFileUpload 8 params body → 200
GET
/w/{workspace}/job_helpers/download_s3_file
Download File from S3 Bucket
fileDownload 5 params → 200
GET
/w/{workspace}/job_helpers/download_s3_parquet_file_as_csv
Download File to S3 Bucket
fileDownloadParquetAsCsv 4 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are S3Resource (7 properties), WindmillFileMetadata (5 properties), WindmillFilePreview (3 properties), WindmillLargeFile (1 property). Each schema is shown below with its type and property counts.

PolarsClientKwargs
object
1 property 1 required
WindmillFileMetadata
object
5 properties
WindmillFilePreview
object
3 properties 1 required
WindmillLargeFile
object
1 property 1 required
S3Resource
object
7 properties 5 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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