Prefect Cloud API — Workspace Invitations

naftiko: 1.0.0-alpha2
info:
  label: Prefect Cloud API — Workspace Invitations
  description: 'Prefect Cloud API — Workspace Invitations. 4 operations. Lead operation: Create Workspace Invitation. Self-contained
    Naftiko capability covering one Prefect business surface.'
  tags:
  - Prefect
  - Workspace Invitations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PREFECT_API_KEY: PREFECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: prefect-workspace-invitations
    baseUri: ''
    description: Prefect Cloud API — Workspace Invitations business capability. Self-contained, no shared references.
    resources:
    - name: api-accounts-account_id-workspaces-workspace_id-invitations
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/invitations/
      operations:
      - name: createworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationspost
        method: POST
        description: Create Workspace Invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_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-invitations-filter
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/invitations/filter
      operations:
      - name: readworkspaceinvitationsapiaccountsaccountidworkspacesworkspaceidinvitationsfilterpost
        method: POST
        description: Read Workspace Invitations
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: workspace_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-invitations-id
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/invitations/{id}
      operations:
      - name: readworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidget
        method: GET
        description: Read Workspace Invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-invitations-id-revoke
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/invitations/{id}/revoke
      operations:
      - name: revokeworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidrevokepost
        method: POST
        description: Revoke Workspace Invitation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: account_id
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          required: true
        - name: workspace_id
          in: path
          type: string
          required: true
  exposes:
  - type: rest
    namespace: prefect-workspace-invitations-rest
    port: 8080
    description: REST adapter for Prefect Cloud API — Workspace Invitations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/invitations
      name: api-accounts-account-id-workspaces-workspace-id-invitations
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-invitations.
      operations:
      - method: POST
        name: createworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationspost
        description: Create Workspace Invitation
        call: prefect-workspace-invitations.createworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationspost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/invitations/filter
      name: api-accounts-account-id-workspaces-workspace-id-invitations-filter
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-invitations-filter.
      operations:
      - method: POST
        name: readworkspaceinvitationsapiaccountsaccountidworkspacesworkspaceidinvitationsfilterpost
        description: Read Workspace Invitations
        call: prefect-workspace-invitations.readworkspaceinvitationsapiaccountsaccountidworkspacesworkspaceidinvitationsfilterpost
        with:
          account_id: rest.account_id
          workspace_id: rest.workspace_id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/invitations/{id}
      name: api-accounts-account-id-workspaces-workspace-id-invitations-id
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-invitations-id.
      operations:
      - method: GET
        name: readworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidget
        description: Read Workspace Invitation
        call: prefect-workspace-invitations.readworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidget
        with:
          account_id: rest.account_id
          id: rest.id
          workspace_id: rest.workspace_id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/invitations/{id}/revoke
      name: api-accounts-account-id-workspaces-workspace-id-invitations-id-revoke
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-invitations-id-revoke.
      operations:
      - method: POST
        name: revokeworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidrevokepost
        description: Revoke Workspace Invitation
        call: prefect-workspace-invitations.revokeworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidrevokepost
        with:
          account_id: rest.account_id
          id: rest.id
          workspace_id: rest.workspace_id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: prefect-workspace-invitations-mcp
    port: 9090
    transport: http
    description: MCP adapter for Prefect Cloud API — Workspace Invitations. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: create-workspace-invitation
      description: Create Workspace Invitation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspace-invitations.createworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationspost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-workspace-invitations
      description: Read Workspace Invitations
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspace-invitations.readworkspaceinvitationsapiaccountsaccountidworkspacesworkspaceidinvitationsfilterpost
      with:
        account_id: tools.account_id
        workspace_id: tools.workspace_id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-workspace-invitation
      description: Read Workspace Invitation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-workspace-invitations.readworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidget
      with:
        account_id: tools.account_id
        id: tools.id
        workspace_id: tools.workspace_id
      outputParameters:
      - type: object
        mapping: $.
    - name: revoke-workspace-invitation
      description: Revoke Workspace Invitation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-workspace-invitations.revokeworkspaceinvitationapiaccountsaccountidworkspacesworkspaceidinvitationsidrevokepost
      with:
        account_id: tools.account_id
        id: tools.id
        workspace_id: tools.workspace_id
      outputParameters:
      - type: object
        mapping: $.