Prefect Cloud API — Workspaces

naftiko: 1.0.0-alpha2
info:
  label: Prefect Cloud API — Workspaces
  description: 'Prefect Cloud API — Workspaces. 11 operations. Lead operation: Create Workspace. Self-contained Naftiko capability
    covering one Prefect business surface.'
  tags:
  - Prefect
  - Workspaces
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PREFECT_API_KEY: PREFECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: prefect-workspaces
    baseUri: ''
    description: Prefect Cloud API — Workspaces business capability. Self-contained, no shared references.
    resources:
    - name: api-accounts-account_id-workspaces
      path: /api/accounts/{account_id}/workspaces/
      operations:
      - name: createworkspaceapiaccountsaccountidworkspacespost
        method: POST
        description: Create Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-filter
      path: /api/accounts/{account_id}/workspaces/filter
      operations:
      - name: readworkspacesapiaccountsaccountidworkspacesfilterpost
        method: POST
        description: Read Workspaces
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id
      path: /api/accounts/{account_id}/workspaces/{workspace_id}
      operations:
      - name: readworkspaceapiaccountsaccountidworkspacesworkspaceidget
        method: GET
        description: Read Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
      - name: updateworkspaceapiaccountsaccountidworkspacesworkspaceidpatch
        method: PATCH
        description: Update Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteworkspaceapiaccountsaccountidworkspacesworkspaceiddelete
        method: DELETE
        description: Delete Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-managed_execution-details
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/managed_execution/details
      operations:
      - name: readmanagedexecutiondetailsapiaccountsaccountidworkspacesworkspaceidmanagedexecutiondetailsget
        method: GET
        description: Read Managed Execution Details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-settings
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/settings
      operations:
      - name: readworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingsget
        method: GET
        description: Read Workspace Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
      - name: updateworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingspatch
        method: PATCH
        description: Update Workspace Settings
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-transfer
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/transfer
      operations:
      - name: transferworkspaceapiaccountsaccountidworkspacesworkspaceidtransferpost
        method: POST
        description: Transfer Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-validate_transfer
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/validate_transfer
      operations:
      - name: validatetransferworkspaceapiaccountsaccountidworkspacesworkspaceidvalidatetransferpost
        method: POST
        description: Validate Transfer Workspace
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-workspaces-workspace_id
      path: /api/workspaces/{workspace_id}
      operations:
      - name: findworkspacewithoutaccountidapiworkspacesworkspaceidget
        method: GET
        description: Find Workspace Without Account Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: prefect-workspaces-rest
    port: 8080
    description: REST adapter for Prefect Cloud API — Workspaces. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/accounts/{account-id}/workspaces
      name: api-accounts-account-id-workspaces
      description: REST surface for api-accounts-account_id-workspaces.
      operations:
      - method: POST
        name: createworkspaceapiaccountsaccountidworkspacespost
        description: Create Workspace
        call: prefect-workspaces.createworkspaceapiaccountsaccountidworkspacespost
        with:
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/filter
      name: api-accounts-account-id-workspaces-filter
      description: REST surface for api-accounts-account_id-workspaces-filter.
      operations:
      - method: POST
        name: readworkspacesapiaccountsaccountidworkspacesfilterpost
        description: Read Workspaces
        call: prefect-workspaces.readworkspacesapiaccountsaccountidworkspacesfilterpost
        with:
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}
      name: api-accounts-account-id-workspaces-workspace-id
      description: REST surface for api-accounts-account_id-workspaces-workspace_id.
      operations:
      - method: GET
        name: readworkspaceapiaccountsaccountidworkspacesworkspaceidget
        description: Read Workspace
        call: prefect-workspaces.readworkspaceapiaccountsaccountidworkspacesworkspaceidget
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateworkspaceapiaccountsaccountidworkspacesworkspaceidpatch
        description: Update Workspace
        call: prefect-workspaces.updateworkspaceapiaccountsaccountidworkspacesworkspaceidpatch
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteworkspaceapiaccountsaccountidworkspacesworkspaceiddelete
        description: Delete Workspace
        call: prefect-workspaces.deleteworkspaceapiaccountsaccountidworkspacesworkspaceiddelete
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/managed-execution/details
      name: api-accounts-account-id-workspaces-workspace-id-managed-execution-details
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-managed_execution-details.
      operations:
      - method: GET
        name: readmanagedexecutiondetailsapiaccountsaccountidworkspacesworkspaceidmanagedexecutiondetailsget
        description: Read Managed Execution Details
        call: prefect-workspaces.readmanagedexecutiondetailsapiaccountsaccountidworkspacesworkspaceidmanagedexecutiondetailsget
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/settings
      name: api-accounts-account-id-workspaces-workspace-id-settings
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-settings.
      operations:
      - method: GET
        name: readworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingsget
        description: Read Workspace Settings
        call: prefect-workspaces.readworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingsget
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingspatch
        description: Update Workspace Settings
        call: prefect-workspaces.updateworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingspatch
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/transfer
      name: api-accounts-account-id-workspaces-workspace-id-transfer
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-transfer.
      operations:
      - method: POST
        name: transferworkspaceapiaccountsaccountidworkspacesworkspaceidtransferpost
        description: Transfer Workspace
        call: prefect-workspaces.transferworkspaceapiaccountsaccountidworkspacesworkspaceidtransferpost
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/validate-transfer
      name: api-accounts-account-id-workspaces-workspace-id-validate-transfer
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-validate_transfer.
      operations:
      - method: POST
        name: validatetransferworkspaceapiaccountsaccountidworkspacesworkspaceidvalidatetransferpost
        description: Validate Transfer Workspace
        call: prefect-workspaces.validatetransferworkspaceapiaccountsaccountidworkspacesworkspaceidvalidatetransferpost
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/workspaces/{workspace-id}
      name: api-workspaces-workspace-id
      description: REST surface for api-workspaces-workspace_id.
      operations:
      - method: GET
        name: findworkspacewithoutaccountidapiworkspacesworkspaceidget
        description: Find Workspace Without Account Id
        call: prefect-workspaces.findworkspacewithoutaccountidapiworkspacesworkspaceidget
        with:
          workspace_id: rest.workspace_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: prefect-workspaces-mcp
    port: 9090
    transport: http
    description: MCP adapter for Prefect Cloud API — Workspaces. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-workspace
      description: Create Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspaces.createworkspaceapiaccountsaccountidworkspacespost
      with:
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-workspaces
      description: Read Workspaces
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspaces.readworkspacesapiaccountsaccountidworkspacesfilterpost
      with:
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-workspace
      description: Read Workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-workspaces.readworkspaceapiaccountsaccountidworkspacesworkspaceidget
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-workspace
      description: Update Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: prefect-workspaces.updateworkspaceapiaccountsaccountidworkspacesworkspaceidpatch
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-workspace
      description: Delete Workspace
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: prefect-workspaces.deleteworkspaceapiaccountsaccountidworkspacesworkspaceiddelete
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
      outputParameters:
      - type: object
        mapping: $.
    - name: read-managed-execution-details
      description: Read Managed Execution Details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-workspaces.readmanagedexecutiondetailsapiaccountsaccountidworkspacesworkspaceidmanagedexecutiondetailsget
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
      outputParameters:
      - type: object
        mapping: $.
    - name: read-workspace-settings
      description: Read Workspace Settings
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-workspaces.readworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingsget
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-workspace-settings
      description: Update Workspace Settings
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: prefect-workspaces.updateworkspacesettingsapiaccountsaccountidworkspacesworkspaceidsettingspatch
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: transfer-workspace
      description: Transfer Workspace
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspaces.transferworkspaceapiaccountsaccountidworkspacesworkspaceidtransferpost
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: validate-transfer-workspace
      description: Validate Transfer Workspace
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: prefect-workspaces.validatetransferworkspaceapiaccountsaccountidworkspacesworkspaceidvalidatetransferpost
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: find-workspace-without-account-id
      description: Find Workspace Without Account Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-workspaces.findworkspacewithoutaccountidapiworkspacesworkspaceidget
      with:
        workspace_id: tools.workspace_id
      outputParameters:
      - type: object
        mapping: $.