Windmill

Windmill asset API

The asset API from Windmill — 3 operation(s) for asset.

GitHub OpenAPI

Operations 3

GET /w/{workspace}/assets/list List All Assets in the Workspace with Cursor Pagination #
POST /w/{workspace}/assets/list_by_usages List All Assets Used by Given Usages Paths #
GET /w/{workspace}/assets/list_favorites List All Favorite Assets for the Authenticated User #

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-asset-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-asset-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-asset-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 1.694.0
  title: Windmill admin Asset 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:
- name: asset
paths:
  /w/{workspace}/assets/list:
    get:
      summary: List All Assets in the Workspace with Cursor Pagination
      operationId: listAssets
      tags:
      - asset
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      - name: per_page
        in: query
        description: Number of items per page (max 1000, default 50)
        schema:
          type: integer
          default: 50
          minimum: 1
          maximum: 1000
      - name: cursor_created_at
        in: query
        description: Cursor timestamp for pagination (created_at of last item from previous page)
        schema:
          type: string
          format: date-time
      - name: cursor_id
        in: query
        description: Cursor ID for pagination (id of last item from previous page)
        schema:
          type: integer
          format: int64
      - name: asset_path
        in: query
        description: Filter by asset path (case-insensitive partial match)
        schema:
          type: string
      - name: usage_path
        in: query
        description: Filter by usage path (case-insensitive partial match)
        schema:
          type: string
      - name: asset_kinds
        in: query
        description: Filter by asset kinds (multiple values allowed)
        schema:
          type: string
      - name: path
        in: query
        description: exact path match filter
        schema:
          type: string
      - name: columns
        in: query
        description: JSONB subset match filter for columns using base64 encoded JSON
        schema:
          type: string
      - name: broad_filter
        description: broad search across multiple fields (case-insensitive substring match)
        in: query
        schema:
          type: string
      responses:
        '200':
          description: paginated assets in the workspace
          content:
            application/json:
              schema:
                type: object
                required:
                - assets
                properties:
                  assets:
                    type: array
                    items:
                      type: object
                      required:
                      - path
                      - kind
                      - usages
                      properties:
                        path:
                          type: string
                        kind:
                          $ref: '#/components/schemas/AssetKind'
                        usages:
                          type: array
                          items:
                            type: object
                            required:
                            - path
                            - kind
                            properties:
                              path:
                                type: string
                              kind:
                                $ref: '#/components/schemas/AssetUsageKind'
                              access_type:
                                $ref: '#/components/schemas/AssetUsageAccessType'
                              columns:
                                type: object
                                description: The columns used (for tables)
                                additionalProperties:
                                  $ref: '#/components/schemas/AssetUsageAccessType'
                              created_at:
                                type: string
                                format: date-time
                                description: When the asset was detected
                              metadata:
                                type: object
                                properties:
                                  runnable_path:
                                    type: string
                                    description: The path of the script/flow that was run (only present when kind is 'job')
                                  job_kind:
                                    type: string
                                    description: The kind of job (script, flow, preview, etc.) (only present when kind is 'job')
                        metadata:
                          type: object
                          properties:
                            resource_type:
                              type: string
                              description: The type of the resource (only present when kind is 'resource')
                  next_cursor:
                    type:
                    - object
                    - 'null'
                    description: Cursor for the next page (null if no more pages)
                    properties:
                      created_at:
                        type: string
                        format: date-time
                        description: Timestamp to use for next page
                      id:
                        type: integer
                        format: int64
                        description: ID to use for next page
  /w/{workspace}/assets/list_by_usages:
    post:
      summary: List All Assets Used by Given Usages Paths
      operationId: listAssetsByUsage
      tags:
      - asset
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      requestBody:
        description: list assets by usages
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - usages
              properties:
                usages:
                  type: array
                  items:
                    type: object
                    required:
                    - path
                    - kind
                    properties:
                      path:
                        type: string
                      kind:
                        $ref: '#/components/schemas/AssetUsageKind'
      responses:
        '200':
          description: all assets used by the given usage paths, in the same order
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    type: object
                    required:
                    - path
                    - kind
                    properties:
                      path:
                        type: string
                      kind:
                        $ref: '#/components/schemas/AssetKind'
                      access_type:
                        $ref: '#/components/schemas/AssetUsageAccessType'
  /w/{workspace}/assets/list_favorites:
    get:
      summary: List All Favorite Assets for the Authenticated User
      operationId: listFavoriteAssets
      tags:
      - asset
      parameters:
      - $ref: '#/components/parameters/WorkspaceId'
      responses:
        '200':
          description: list of favorite assets
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  required:
                  - path
                  properties:
                    path:
                      type: string
                      description: The asset path
components:
  parameters:
    WorkspaceId:
      name: workspace
      in: path
      required: true
      schema:
        type: string
  schemas:
    AssetKind:
      type: string
      enum:
      - s3object
      - resource
      - ducklake
      - datatable
      - volume
    AssetUsageKind:
      type: string
      enum:
      - script
      - flow
      - job
    AssetUsageAccessType:
      type:
      - string
      - 'null'
      enum:
      - r
      - w
      - rw
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    cookieAuth:
      type: apiKey
      in: cookie
      name: token
externalDocs:
  description: documentation portal
  url: https://windmill.dev