Windmill API — flow

naftiko: 1.0.0-alpha2
info:
  label: Windmill API — flow
  description: 'Windmill API — flow. 21 operations. Lead operation: Get Hub Flow by Id. Self-contained Naftiko capability
    covering one Windmill business surface.'
  tags:
  - Windmill
  - flow
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WINDMILL_API_KEY: WINDMILL_API_KEY
capability:
  consumes:
  - type: http
    namespace: windmill-flow
    baseUri: ''
    description: Windmill API — flow business capability. Self-contained, no shared references.
    resources:
    - name: flows-hub-get-id
      path: /flows/hub/get/{id}
      operations:
      - name: gethubflowbyid
        method: GET
        description: Get Hub Flow by Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: flows-hub-list
      path: /flows/hub/list
      operations:
      - name: listhubflows
        method: GET
        description: List All Hub Flows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-archive-path
      path: /w/{workspace}/flows/archive/{path}
      operations:
      - name: archiveflowbypath
        method: POST
        description: Archive Flow by Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-flows-create
      path: /w/{workspace}/flows/create
      operations:
      - name: createflow
        method: POST
        description: Create Flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-flows-delete-path
      path: /w/{workspace}/flows/delete/{path}
      operations:
      - name: deleteflowbypath
        method: DELETE
        description: Delete Flow by Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: keep_captures
          in: query
          type: boolean
          description: keep captures
    - name: w-workspace-flows-deployment_status-p-path
      path: /w/{workspace}/flows/deployment_status/p/{path}
      operations:
      - name: getflowdeploymentstatus
        method: GET
        description: Get Flow Deployment Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-exists-path
      path: /w/{workspace}/flows/exists/{path}
      operations:
      - name: existsflowbypath
        method: GET
        description: Exists Flow by Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-get-draft-path
      path: /w/{workspace}/flows/get/draft/{path}
      operations:
      - name: getflowbypathwithdraft
        method: GET
        description: Get Flow by Path with Draft
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-get-v-version
      path: /w/{workspace}/flows/get/v/{version}
      operations:
      - name: getflowversion
        method: GET
        description: Get Flow Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: path
          type: number
          required: true
    - name: w-workspace-flows-get-path
      path: /w/{workspace}/flows/get/{path}
      operations:
      - name: getflowbypath
        method: GET
        description: Get Flow by Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: with_starred_info
          in: query
          type: boolean
    - name: w-workspace-flows-get_latest_version-path
      path: /w/{workspace}/flows/get_latest_version/{path}
      operations:
      - name: getflowlatestversion
        method: GET
        description: Get Flow's Latest Version
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-get_triggers_count-path
      path: /w/{workspace}/flows/get_triggers_count/{path}
      operations:
      - name: gettriggerscountofflow
        method: GET
        description: Get Triggers Count of Flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-history-p-path
      path: /w/{workspace}/flows/history/p/{path}
      operations:
      - name: getflowhistory
        method: GET
        description: Get Flow History by Path
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-history_update-v-version
      path: /w/{workspace}/flows/history_update/v/{version}
      operations:
      - name: updateflowhistory
        method: POST
        description: Update Flow History
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: version
          in: path
          type: number
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-flows-list
      path: /w/{workspace}/flows/list
      operations:
      - name: listflows
        method: GET
        description: List All Flows
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: path_start
          in: query
          type: string
          description: mask to filter matching starting path
        - name: path_exact
          in: query
          type: string
          description: mask to filter exact matching path
        - name: show_archived
          in: query
          type: boolean
          description: (default false)
        - name: starred_only
          in: query
          type: boolean
          description: (default false)
        - name: include_draft_only
          in: query
          type: boolean
          description: (default false)
        - name: with_deployment_msg
          in: query
          type: boolean
          description: (default false)
        - name: without_description
          in: query
          type: boolean
          description: (default false)
        - name: dedicated_worker
          in: query
          type: boolean
          description: (default regardless)
        - name: label
          in: query
          type: string
          description: Filter by label
    - name: w-workspace-flows-list_paths
      path: /w/{workspace}/flows/list_paths
      operations:
      - name: listflowpaths
        method: GET
        description: List All Flow Paths
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-list_paths_from_workspace_runnable-runnable_kind-path
      path: /w/{workspace}/flows/list_paths_from_workspace_runnable/{runnable_kind}/{path}
      operations:
      - name: listflowpathsfromworkspacerunnable
        method: GET
        description: List Flow Paths from Workspace Runnable
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: match_path_start
          in: query
          type: boolean
    - name: w-workspace-flows-list_search
      path: /w/{workspace}/flows/list_search
      operations:
      - name: listsearchflow
        method: GET
        description: List Flows for Search
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-list_tokens-path
      path: /w/{workspace}/flows/list_tokens/{path}
      operations:
      - name: listtokensofflow
        method: GET
        description: Get Tokens with Flow Scope
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: w-workspace-flows-toggle_workspace_error_handler-path
      path: /w/{workspace}/flows/toggle_workspace_error_handler/{path}
      operations:
      - name: toggleworkspaceerrorhandlerforflow
        method: POST
        description: Toggle ON and OFF the Workspace Error Handler for a Given Flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: w-workspace-flows-update-path
      path: /w/{workspace}/flows/update/{path}
      operations:
      - name: updateflow
        method: POST
        description: Update Flow
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.WINDMILL_API_KEY}}'
  exposes:
  - type: rest
    namespace: windmill-flow-rest
    port: 8080
    description: REST adapter for Windmill API — flow. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/flows/hub/get/{id}
      name: flows-hub-get-id
      description: REST surface for flows-hub-get-id.
      operations:
      - method: GET
        name: gethubflowbyid
        description: Get Hub Flow by Id
        call: windmill-flow.gethubflowbyid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/flows/hub/list
      name: flows-hub-list
      description: REST surface for flows-hub-list.
      operations:
      - method: GET
        name: listhubflows
        description: List All Hub Flows
        call: windmill-flow.listhubflows
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/archive/{path}
      name: w-workspace-flows-archive-path
      description: REST surface for w-workspace-flows-archive-path.
      operations:
      - method: POST
        name: archiveflowbypath
        description: Archive Flow by Path
        call: windmill-flow.archiveflowbypath
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/create
      name: w-workspace-flows-create
      description: REST surface for w-workspace-flows-create.
      operations:
      - method: POST
        name: createflow
        description: Create Flow
        call: windmill-flow.createflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/delete/{path}
      name: w-workspace-flows-delete-path
      description: REST surface for w-workspace-flows-delete-path.
      operations:
      - method: DELETE
        name: deleteflowbypath
        description: Delete Flow by Path
        call: windmill-flow.deleteflowbypath
        with:
          keep_captures: rest.keep_captures
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/deployment-status/p/{path}
      name: w-workspace-flows-deployment-status-p-path
      description: REST surface for w-workspace-flows-deployment_status-p-path.
      operations:
      - method: GET
        name: getflowdeploymentstatus
        description: Get Flow Deployment Status
        call: windmill-flow.getflowdeploymentstatus
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/exists/{path}
      name: w-workspace-flows-exists-path
      description: REST surface for w-workspace-flows-exists-path.
      operations:
      - method: GET
        name: existsflowbypath
        description: Exists Flow by Path
        call: windmill-flow.existsflowbypath
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/get/draft/{path}
      name: w-workspace-flows-get-draft-path
      description: REST surface for w-workspace-flows-get-draft-path.
      operations:
      - method: GET
        name: getflowbypathwithdraft
        description: Get Flow by Path with Draft
        call: windmill-flow.getflowbypathwithdraft
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/get/v/{version}
      name: w-workspace-flows-get-v-version
      description: REST surface for w-workspace-flows-get-v-version.
      operations:
      - method: GET
        name: getflowversion
        description: Get Flow Version
        call: windmill-flow.getflowversion
        with:
          version: rest.version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/get/{path}
      name: w-workspace-flows-get-path
      description: REST surface for w-workspace-flows-get-path.
      operations:
      - method: GET
        name: getflowbypath
        description: Get Flow by Path
        call: windmill-flow.getflowbypath
        with:
          with_starred_info: rest.with_starred_info
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/get-latest-version/{path}
      name: w-workspace-flows-get-latest-version-path
      description: REST surface for w-workspace-flows-get_latest_version-path.
      operations:
      - method: GET
        name: getflowlatestversion
        description: Get Flow's Latest Version
        call: windmill-flow.getflowlatestversion
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/get-triggers-count/{path}
      name: w-workspace-flows-get-triggers-count-path
      description: REST surface for w-workspace-flows-get_triggers_count-path.
      operations:
      - method: GET
        name: gettriggerscountofflow
        description: Get Triggers Count of Flow
        call: windmill-flow.gettriggerscountofflow
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/history/p/{path}
      name: w-workspace-flows-history-p-path
      description: REST surface for w-workspace-flows-history-p-path.
      operations:
      - method: GET
        name: getflowhistory
        description: Get Flow History by Path
        call: windmill-flow.getflowhistory
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/history-update/v/{version}
      name: w-workspace-flows-history-update-v-version
      description: REST surface for w-workspace-flows-history_update-v-version.
      operations:
      - method: POST
        name: updateflowhistory
        description: Update Flow History
        call: windmill-flow.updateflowhistory
        with:
          version: rest.version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/list
      name: w-workspace-flows-list
      description: REST surface for w-workspace-flows-list.
      operations:
      - method: GET
        name: listflows
        description: List All Flows
        call: windmill-flow.listflows
        with:
          path_start: rest.path_start
          path_exact: rest.path_exact
          show_archived: rest.show_archived
          starred_only: rest.starred_only
          include_draft_only: rest.include_draft_only
          with_deployment_msg: rest.with_deployment_msg
          without_description: rest.without_description
          dedicated_worker: rest.dedicated_worker
          label: rest.label
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/list-paths
      name: w-workspace-flows-list-paths
      description: REST surface for w-workspace-flows-list_paths.
      operations:
      - method: GET
        name: listflowpaths
        description: List All Flow Paths
        call: windmill-flow.listflowpaths
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/list-paths-from-workspace-runnable/{runnable-kind}/{path}
      name: w-workspace-flows-list-paths-from-workspace-runnable-runnable-kind-path
      description: REST surface for w-workspace-flows-list_paths_from_workspace_runnable-runnable_kind-path.
      operations:
      - method: GET
        name: listflowpathsfromworkspacerunnable
        description: List Flow Paths from Workspace Runnable
        call: windmill-flow.listflowpathsfromworkspacerunnable
        with:
          match_path_start: rest.match_path_start
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/list-search
      name: w-workspace-flows-list-search
      description: REST surface for w-workspace-flows-list_search.
      operations:
      - method: GET
        name: listsearchflow
        description: List Flows for Search
        call: windmill-flow.listsearchflow
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/list-tokens/{path}
      name: w-workspace-flows-list-tokens-path
      description: REST surface for w-workspace-flows-list_tokens-path.
      operations:
      - method: GET
        name: listtokensofflow
        description: Get Tokens with Flow Scope
        call: windmill-flow.listtokensofflow
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/toggle-workspace-error-handler/{path}
      name: w-workspace-flows-toggle-workspace-error-handler-path
      description: REST surface for w-workspace-flows-toggle_workspace_error_handler-path.
      operations:
      - method: POST
        name: toggleworkspaceerrorhandlerforflow
        description: Toggle ON and OFF the Workspace Error Handler for a Given Flow
        call: windmill-flow.toggleworkspaceerrorhandlerforflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/w/{workspace}/flows/update/{path}
      name: w-workspace-flows-update-path
      description: REST surface for w-workspace-flows-update-path.
      operations:
      - method: POST
        name: updateflow
        description: Update Flow
        call: windmill-flow.updateflow
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: windmill-flow-mcp
    port: 9090
    transport: http
    description: MCP adapter for Windmill API — flow. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: get-hub-flow-id
      description: Get Hub Flow by Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.gethubflowbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-hub-flows
      description: List All Hub Flows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listhubflows
      outputParameters:
      - type: object
        mapping: $.
    - name: archive-flow-path
      description: Archive Flow by Path
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-flow.archiveflowbypath
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: create-flow
      description: Create Flow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-flow.createflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-flow-path
      description: Delete Flow by Path
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: windmill-flow.deleteflowbypath
      with:
        keep_captures: tools.keep_captures
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-deployment-status
      description: Get Flow Deployment Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowdeploymentstatus
      outputParameters:
      - type: object
        mapping: $.
    - name: exists-flow-path
      description: Exists Flow by Path
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.existsflowbypath
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-path-draft
      description: Get Flow by Path with Draft
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowbypathwithdraft
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-version
      description: Get Flow Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowversion
      with:
        version: tools.version
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-path
      description: Get Flow by Path
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowbypath
      with:
        with_starred_info: tools.with_starred_info
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-s-latest-version
      description: Get Flow's Latest Version
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowlatestversion
      outputParameters:
      - type: object
        mapping: $.
    - name: get-triggers-count-flow
      description: Get Triggers Count of Flow
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.gettriggerscountofflow
      outputParameters:
      - type: object
        mapping: $.
    - name: get-flow-history-path
      description: Get Flow History by Path
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.getflowhistory
      outputParameters:
      - type: object
        mapping: $.
    - name: update-flow-history
      description: Update Flow History
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-flow.updateflowhistory
      with:
        version: tools.version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-flows
      description: List All Flows
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listflows
      with:
        path_start: tools.path_start
        path_exact: tools.path_exact
        show_archived: tools.show_archived
        starred_only: tools.starred_only
        include_draft_only: tools.include_draft_only
        with_deployment_msg: tools.with_deployment_msg
        without_description: tools.without_description
        dedicated_worker: tools.dedicated_worker
        label: tools.label
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-flow-paths
      description: List All Flow Paths
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listflowpaths
      outputParameters:
      - type: object
        mapping: $.
    - name: list-flow-paths-workspace-runnable
      description: List Flow Paths from Workspace Runnable
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listflowpathsfromworkspacerunnable
      with:
        match_path_start: tools.match_path_start
      outputParameters:
      - type: object
        mapping: $.
    - name: list-flows-search
      description: List Flows for Search
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listsearchflow
      outputParameters:
      - type: object
        mapping: $.
    - name: get-tokens-flow-scope
      description: Get Tokens with Flow Scope
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: windmill-flow.listtokensofflow
      outputParameters:
      - type: object
        mapping: $.
    - name: toggle-and-off-workspace-error
      description: Toggle ON and OFF the Workspace Error Handler for a Given Flow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-flow.toggleworkspaceerrorhandlerforflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: update-flow
      description: Update Flow
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: windmill-flow.updateflow
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.