Prefect · Capability
Prefect Cloud API — Block types
Prefect Cloud API — Block types. 11 operations. Lead operation: Create Block Type. Self-contained Naftiko capability covering one Prefect business surface.
What You Can Do
POST
Createblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypespost
— Create Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types
POST
Readblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesfilterpost
— Read Block Types
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/filter
POST
Installsystemblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesinstallsystemblocktypespost
— Install System Block Types
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/install-system-block-types
GET
Readblocktypebyslugapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugget
— Read Block Type By Slug
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}
GET
Readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
— Read Block Documents For Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents
GET
Readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
— Read Block Documents For Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents
GET
Readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
— Read Block Document By Name For Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents/name/{block-document-name}
GET
Readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
— Read Block Document By Name For Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents/name/{block-document-name}
GET
Readblocktypebyidapiaccountsaccountidworkspacesworkspaceidblocktypesidget
— Read Block Type By Id
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/{id}
PATCH
Updateblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesidpatch
— Update Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/{id}
DELETE
Deleteblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesiddelete
— Delete Block Type
/v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/{id}
MCP Tools
create-block-type
Create Block Type
read-block-types
Read Block Types
install-system-block-types
Install System Block Types
read-block-type-slug
Read Block Type By Slug
read-only
idempotent
read-block-documents-block-type
Read Block Documents For Block Type
read-only
idempotent
read-block-documents-block-type-2
Read Block Documents For Block Type
read-only
idempotent
read-block-document-name-block
Read Block Document By Name For Block Type
read-only
idempotent
read-block-document-name-block-2
Read Block Document By Name For Block Type
read-only
idempotent
read-block-type-id
Read Block Type By Id
read-only
idempotent
update-block-type
Update Block Type
idempotent
delete-block-type
Delete Block Type
idempotent
Capability Spec
naftiko: 1.0.0-alpha2
info:
label: Prefect Cloud API — Block types
description: 'Prefect Cloud API — Block types. 11 operations. Lead operation: Create Block Type. Self-contained Naftiko
capability covering one Prefect business surface.'
tags:
- Prefect
- Block types
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-types
baseUri: ''
description: Prefect Cloud API — Block types business capability. Self-contained, no shared references.
resources:
- name: api-accounts-account_id-workspaces-workspace_id-block_types
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/
operations:
- name: createblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypespost
method: POST
description: Create Block Type
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: 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_types-filter
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/filter
operations:
- name: readblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesfilterpost
method: POST
description: Read Block Types
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: 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_types-install_system_block
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/install_system_block_types
operations:
- name: installsystemblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesinstallsystemblocktypespost
method: POST
description: Install System Block Types
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: api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}
operations:
- name: readblocktypebyslugapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugget
method: GET
description: Read Block Type By Slug
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: slug
in: path
type: string
description: The block type name
required: true
- name: account_id
in: path
type: string
required: true
- name: workspace_id
in: path
type: string
required: true
- name: x-prefect-api-version
in: header
type: string
- name: api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug-block_docu
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents
operations:
- name: readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
method: GET
description: Read Block Documents For Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: workspace_id
in: path
type: string
required: true
- name: slug
in: path
type: string
description: The block type name
required: true
- name: account_id
in: path
type: string
required: true
- name: include_secrets
in: query
type: boolean
description: Whether to include sensitive values in the block document.
- name: x-prefect-api-version
in: header
type: string
- name: readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
method: GET
description: Read Block Documents For Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: workspace_id
in: path
type: string
required: true
- name: slug
in: path
type: string
description: The block type name
required: true
- name: account_id
in: path
type: string
required: true
- name: include_secrets
in: query
type: boolean
description: Whether to include sensitive values in the block document.
- name: x-prefect-api-version
in: header
type: string
- name: api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug-block_docu
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents/name/{block_document_name}
operations:
- name: readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
method: GET
description: Read Block Document By Name For Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: workspace_id
in: path
type: string
required: true
- name: slug
in: path
type: string
description: The block type name
required: true
- name: block_document_name
in: path
type: string
description: The block type name
required: true
- name: account_id
in: path
type: string
required: true
- name: include_secrets
in: query
type: boolean
description: Whether to include sensitive values in the block document.
- name: x-prefect-api-version
in: header
type: string
- name: readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
method: GET
description: Read Block Document By Name For Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: workspace_id
in: path
type: string
required: true
- name: slug
in: path
type: string
description: The block type name
required: true
- name: block_document_name
in: path
type: string
description: The block type name
required: true
- name: account_id
in: path
type: string
required: true
- name: include_secrets
in: query
type: boolean
description: Whether to include sensitive values in the block document.
- name: x-prefect-api-version
in: header
type: string
- name: api-accounts-account_id-workspaces-workspace_id-block_types-id
path: /api/accounts/{account_id}/workspaces/{workspace_id}/block_types/{id}
operations:
- name: readblocktypebyidapiaccountsaccountidworkspacesworkspaceidblocktypesidget
method: GET
description: Read Block Type By Id
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The block type ID
required: true
- name: account_id
in: path
type: string
required: true
- name: workspace_id
in: path
type: string
required: true
- name: x-prefect-api-version
in: header
type: string
- name: updateblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesidpatch
method: PATCH
description: Update Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The block type ID
required: true
- name: account_id
in: path
type: string
required: true
- name: workspace_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: deleteblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesiddelete
method: DELETE
description: Delete Block Type
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The block type ID
required: true
- name: account_id
in: path
type: string
required: true
- name: workspace_id
in: path
type: string
required: true
- name: x-prefect-api-version
in: header
type: string
exposes:
- type: rest
namespace: prefect-block-types-rest
port: 8080
description: REST adapter for Prefect Cloud API — Block types. One Spectral-compliant resource per consumed operation,
prefixed with /v1.
resources:
- path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types
name: api-accounts-account-id-workspaces-workspace-id-block-types
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types.
operations:
- method: POST
name: createblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypespost
description: Create Block Type
call: prefect-block-types.createblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypespost
with:
account_id: rest.account_id
workspace_id: rest.workspace_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-types/filter
name: api-accounts-account-id-workspaces-workspace-id-block-types-filter
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-filter.
operations:
- method: POST
name: readblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesfilterpost
description: Read Block Types
call: prefect-block-types.readblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesfilterpost
with:
account_id: rest.account_id
workspace_id: rest.workspace_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-types/install-system-block-types
name: api-accounts-account-id-workspaces-workspace-id-block-types-install-system-block
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-install_system_block.
operations:
- method: POST
name: installsystemblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesinstallsystemblocktypespost
description: Install System Block Types
call: prefect-block-types.installsystemblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesinstallsystemblocktypespost
with:
workspace_id: rest.workspace_id
account_id: rest.account_id
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}
name: api-accounts-account-id-workspaces-workspace-id-block-types-slug-slug
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug.
operations:
- method: GET
name: readblocktypebyslugapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugget
description: Read Block Type By Slug
call: prefect-block-types.readblocktypebyslugapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugget
with:
slug: rest.slug
account_id: rest.account_id
workspace_id: rest.workspace_id
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents
name: api-accounts-account-id-workspaces-workspace-id-block-types-slug-slug-block-docu
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug-block_docu.
operations:
- method: GET
name: readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
description: Read Block Documents For Block Type
call: prefect-block-types.readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
with:
workspace_id: rest.workspace_id
slug: rest.slug
account_id: rest.account_id
include_secrets: rest.include_secrets
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- method: GET
name: readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
description: Read Block Documents For Block Type
call: prefect-block-types.readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
with:
workspace_id: rest.workspace_id
slug: rest.slug
account_id: rest.account_id
include_secrets: rest.include_secrets
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/slug/{slug}/block-documents/name/{block-document-name}
name: api-accounts-account-id-workspaces-workspace-id-block-types-slug-slug-block-docu
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-slug-slug-block_docu.
operations:
- method: GET
name: readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
description: Read Block Document By Name For Block Type
call: prefect-block-types.readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
with:
workspace_id: rest.workspace_id
slug: rest.slug
block_document_name: rest.block_document_name
account_id: rest.account_id
include_secrets: rest.include_secrets
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- method: GET
name: readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
description: Read Block Document By Name For Block Type
call: prefect-block-types.readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
with:
workspace_id: rest.workspace_id
slug: rest.slug
block_document_name: rest.block_document_name
account_id: rest.account_id
include_secrets: rest.include_secrets
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- path: /v1/api/accounts/{account-id}/workspaces/{workspace-id}/block-types/{id}
name: api-accounts-account-id-workspaces-workspace-id-block-types-id
description: REST surface for api-accounts-account_id-workspaces-workspace_id-block_types-id.
operations:
- method: GET
name: readblocktypebyidapiaccountsaccountidworkspacesworkspaceidblocktypesidget
description: Read Block Type By Id
call: prefect-block-types.readblocktypebyidapiaccountsaccountidworkspacesworkspaceidblocktypesidget
with:
id: rest.id
account_id: rest.account_id
workspace_id: rest.workspace_id
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- method: PATCH
name: updateblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesidpatch
description: Update Block Type
call: prefect-block-types.updateblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesidpatch
with:
id: rest.id
account_id: rest.account_id
workspace_id: rest.workspace_id
x-prefect-api-version: rest.x-prefect-api-version
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: DELETE
name: deleteblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesiddelete
description: Delete Block Type
call: prefect-block-types.deleteblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesiddelete
with:
id: rest.id
account_id: rest.account_id
workspace_id: rest.workspace_id
x-prefect-api-version: rest.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- type: mcp
namespace: prefect-block-types-mcp
port: 9090
transport: http
description: MCP adapter for Prefect Cloud API — Block types. One tool per consumed operation, routed inline through this
capability's consumes block.
tools:
- name: create-block-type
description: Create Block Type
hints:
readOnly: false
destructive: false
idempotent: false
call: prefect-block-types.createblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypespost
with:
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: read-block-types
description: Read Block Types
hints:
readOnly: false
destructive: false
idempotent: false
call: prefect-block-types.readblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesfilterpost
with:
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: install-system-block-types
description: Install System Block Types
hints:
readOnly: false
destructive: false
idempotent: false
call: prefect-block-types.installsystemblocktypesapiaccountsaccountidworkspacesworkspaceidblocktypesinstallsystemblocktypespost
with:
workspace_id: tools.workspace_id
account_id: tools.account_id
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-type-slug
description: Read Block Type By Slug
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblocktypebyslugapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugget
with:
slug: tools.slug
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-documents-block-type
description: Read Block Documents For Block Type
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
with:
workspace_id: tools.workspace_id
slug: tools.slug
account_id: tools.account_id
include_secrets: tools.include_secrets
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-documents-block-type-2
description: Read Block Documents For Block Type
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblockdocumentsforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsget
with:
workspace_id: tools.workspace_id
slug: tools.slug
account_id: tools.account_id
include_secrets: tools.include_secrets
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-document-name-block
description: Read Block Document By Name For Block Type
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
with:
workspace_id: tools.workspace_id
slug: tools.slug
block_document_name: tools.block_document_name
account_id: tools.account_id
include_secrets: tools.include_secrets
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-document-name-block-2
description: Read Block Document By Name For Block Type
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblockdocumentbynameforblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesslugslugblockdocumentsnameblockdocumentnameget
with:
workspace_id: tools.workspace_id
slug: tools.slug
block_document_name: tools.block_document_name
account_id: tools.account_id
include_secrets: tools.include_secrets
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: read-block-type-id
description: Read Block Type By Id
hints:
readOnly: true
destructive: false
idempotent: true
call: prefect-block-types.readblocktypebyidapiaccountsaccountidworkspacesworkspaceidblocktypesidget
with:
id: tools.id
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.
- name: update-block-type
description: Update Block Type
hints:
readOnly: false
destructive: false
idempotent: true
call: prefect-block-types.updateblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesidpatch
with:
id: tools.id
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
body: tools.body
outputParameters:
- type: object
mapping: $.
- name: delete-block-type
description: Delete Block Type
hints:
readOnly: false
destructive: true
idempotent: true
call: prefect-block-types.deleteblocktypeapiaccountsaccountidworkspacesworkspaceidblocktypesiddelete
with:
id: tools.id
account_id: tools.account_id
workspace_id: tools.workspace_id
x-prefect-api-version: tools.x-prefect-api-version
outputParameters:
- type: object
mapping: $.