Prefect Cloud API — Block schemas

naftiko: 1.0.0-alpha2
info:
  label: Prefect Cloud API — Block schemas
  description: 'Prefect Cloud API — Block schemas. 5 operations. Lead operation: Create Block Schema. Self-contained Naftiko
    capability covering one Prefect business surface.'
  tags:
  - Prefect
  - Block schemas
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PREFECT_API_KEY: PREFECT_API_KEY
capability:
  consumes:
  - type: http
    namespace: prefect-block-schemas
    baseUri: ''
    description: Prefect Cloud API — Block schemas business capability. Self-contained, no shared references.
    resources:
    - name: api-accounts-account_id-workspaces-workspace_id-block_schemas
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/
      operations:
      - name: createblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemaspost
        method: POST
        description: Create Block Schema
        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: x-prefect-api-version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: api-accounts-account_id-workspaces-workspace_id-block_schemas-checksum-checksum
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/checksum/{checksum}
      operations:
      - name: readblockschemabychecksumapiaccountsaccountidworkspacesworkspaceidblockschemaschecksumchecksumget
        method: GET
        description: Read Block Schema By Checksum
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: checksum
          in: path
          type: string
          description: The block schema checksum
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: version
          in: query
          type: string
          description: Version of block schema. If not provided the most recently created block schema with the matching checksum
            will be returned.
        - name: x-prefect-api-version
          in: header
          type: string
    - name: api-accounts-account_id-workspaces-workspace_id-block_schemas-filter
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/filter
      operations:
      - name: readblockschemasapiaccountsaccountidworkspacesworkspaceidblockschemasfilterpost
        method: POST
        description: Read Block Schemas
        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: x-prefect-api-version
          in: header
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: false
    - name: api-accounts-account_id-workspaces-workspace_id-block_schemas-id
      path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_schemas/{id}
      operations:
      - name: deleteblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemasiddelete
        method: DELETE
        description: Delete Block Schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          description: The block schema id
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: x-prefect-api-version
          in: header
          type: string
      - name: readblockschemabyidapiaccountsaccountidworkspacesworkspaceidblockschemasidget
        method: GET
        description: Read Block Schema By Id
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: workspace_id
          in: path
          type: string
          required: true
        - name: id
          in: path
          type: string
          description: The block schema id
          required: true
        - name: account_id
          in: path
          type: string
          required: true
        - name: x-prefect-api-version
          in: header
          type: string
  exposes:
  - type: rest
    namespace: prefect-block-schemas-rest
    port: 8080
    description: REST adapter for Prefect Cloud API — Block schemas. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-schemas
      name: api-accounts-account-id-workspaces-workspace-id-block-schemas
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_schemas.
      operations:
      - method: POST
        name: createblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemaspost
        description: Create Block Schema
        call: prefect-block-schemas.createblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemaspost
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          x-prefect-api-version: rest.x-prefect-api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-schemas/checksum/{checksum}
      name: api-accounts-account-id-workspaces-workspace-id-block-schemas-checksum-checksum
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_schemas-checksum-checksum.
      operations:
      - method: GET
        name: readblockschemabychecksumapiaccountsaccountidworkspacesworkspaceidblockschemaschecksumchecksumget
        description: Read Block Schema By Checksum
        call: prefect-block-schemas.readblockschemabychecksumapiaccountsaccountidworkspacesworkspaceidblockschemaschecksumchecksumget
        with:
          workspace_id: rest.workspace_id
          checksum: rest.checksum
          account_id: rest.account_id
          version: rest.version
          x-prefect-api-version: rest.x-prefect-api-version
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-schemas/filter
      name: api-accounts-account-id-workspaces-workspace-id-block-schemas-filter
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_schemas-filter.
      operations:
      - method: POST
        name: readblockschemasapiaccountsaccountidworkspacesworkspaceidblockschemasfilterpost
        description: Read Block Schemas
        call: prefect-block-schemas.readblockschemasapiaccountsaccountidworkspacesworkspaceidblockschemasfilterpost
        with:
          workspace_id: rest.workspace_id
          account_id: rest.account_id
          x-prefect-api-version: rest.x-prefect-api-version
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-schemas/{id}
      name: api-accounts-account-id-workspaces-workspace-id-block-schemas-id
      description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_schemas-id.
      operations:
      - method: DELETE
        name: deleteblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemasiddelete
        description: Delete Block Schema
        call: prefect-block-schemas.deleteblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemasiddelete
        with:
          workspace_id: rest.workspace_id
          id: rest.id
          account_id: rest.account_id
          x-prefect-api-version: rest.x-prefect-api-version
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: readblockschemabyidapiaccountsaccountidworkspacesworkspaceidblockschemasidget
        description: Read Block Schema By Id
        call: prefect-block-schemas.readblockschemabyidapiaccountsaccountidworkspacesworkspaceidblockschemasidget
        with:
          workspace_id: rest.workspace_id
          id: rest.id
          account_id: rest.account_id
          x-prefect-api-version: rest.x-prefect-api-version
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: prefect-block-schemas-mcp
    port: 9090
    transport: http
    description: MCP adapter for Prefect Cloud API — Block schemas. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-block-schema
      description: Create Block Schema
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-block-schemas.createblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemaspost
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        x-prefect-api-version: tools.x-prefect-api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: read-block-schema-checksum
      description: Read Block Schema By Checksum
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-block-schemas.readblockschemabychecksumapiaccountsaccountidworkspacesworkspaceidblockschemaschecksumchecksumget
      with:
        workspace_id: tools.workspace_id
        checksum: tools.checksum
        account_id: tools.account_id
        version: tools.version
        x-prefect-api-version: tools.x-prefect-api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: read-block-schemas
      description: Read Block Schemas
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: prefect-block-schemas.readblockschemasapiaccountsaccountidworkspacesworkspaceidblockschemasfilterpost
      with:
        workspace_id: tools.workspace_id
        account_id: tools.account_id
        x-prefect-api-version: tools.x-prefect-api-version
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-block-schema
      description: Delete Block Schema
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: prefect-block-schemas.deleteblockschemaapiaccountsaccountidworkspacesworkspaceidblockschemasiddelete
      with:
        workspace_id: tools.workspace_id
        id: tools.id
        account_id: tools.account_id
        x-prefect-api-version: tools.x-prefect-api-version
      outputParameters:
      - type: object
        mapping: $.
    - name: read-block-schema-id
      description: Read Block Schema By Id
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: prefect-block-schemas.readblockschemabyidapiaccountsaccountidworkspacesworkspaceidblockschemasidget
      with:
        workspace_id: tools.workspace_id
        id: tools.id
        account_id: tools.account_id
        x-prefect-api-version: tools.x-prefect-api-version
      outputParameters:
      - type: object
        mapping: $.