How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Prefect Block documents API

Interact with a Workspace's Blocks.

Prefect Block documents API is one of 63 APIs that Prefect publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include Block documents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, a getting-started guide, and an AsyncAPI specification.

This API exposes 12 operations across 8 paths, and defines 29 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

12 operations 8 paths 29 schemas 1 DELETE4 GET1 PATCH4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.8.4
Resource Areas
1

Paths & Operations 12

Across 8 paths, the API surfaces 12 operations — 1 DELETE, 4 GET, 1 PATCH, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Block documents 12

Interact with a Workspace's Blocks.

GET
/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents
Read Block Documents For Block Type
read_block_documents_for_block_type_api_accounts__account_id__workspaces__workspace_id__block_types_slug__slug__block_documents_get 5 params → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/block_types/slug/{slug}/block_documents/name/{block_document_name}
Read Block Document By Name For Block Type
read_block_document_by_name_for_block_type_api_accounts__account_id__workspaces__workspace_id__block_types_slug__slug__block_documents_name__block_document_name__get 6 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/
Create Block Document
create_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__post 3 params body → 201422
PUT
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/
Create Or Update Block Document
create_or_update_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__put 3 params body → 201422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/filter
Read Block Documents
read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/count
Count Block Documents
count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post 3 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}
Read Block Document By Id
read_block_document_by_id_api_accounts__account_id__workspaces__workspace_id__block_documents__id__get 5 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}
Delete Block Document
delete_block_document_api_accounts__account_id__workspaces__workspace_id__block_documents__id__delete 4 params → 204422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}
Update Block Document Data
update_block_document_data_api_accounts__account_id__workspaces__workspace_id__block_documents__id__patch 4 params body → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}/access
Read Block Document Access
read_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_get 4 params → 200422
PUT
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/{id}/access
Set Block Document Access
set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put 4 params body → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/block_documents/my-access
Read Actors Block Document Access
read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post 3 params body → 200422

Schemas 29

The contract defines 29 schemas that model the data the API accepts and returns. The most detailed are BlockDocument (12 properties), BlockType (10 properties), BlockSchema (9 properties), Body_read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post (7 properties). Each schema is shown below with its type and property counts.

Body_count_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_count_post
object
3 properties
BlockDocumentFilterBlockTypeId
object
Filter by BlockDocument.blocktypeid.
1 property
BlockDocument
object
An ORM representation of a block document.
12 properties 2 required
BlockDocumentSort
string
Defines block document sorting options.
BlockDocumentFilter
object
Filter BlockDocuments. Only BlockDocuments matching all criteria will be returned
5 properties
BlockDocumentFilterName
object
Filter by BlockDocument.name.
2 properties
BlockSchemaFilterCapabilities
object
Filter by BlockSchema.capabilities
1 property
BlockSchemaFilter
object
Filter BlockSchemas
5 properties
BlockDocumentFilterId
object
Filter by BlockDocument.id.
1 property
BlockSchemaFilterBlockTypeId
object
Filter by BlockSchema.blocktypeid.
1 property
BlockDocumentAccessControl
object
A representation of the access control for a block document.
2 properties
Body_read_actors_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents_my_access_post
object
1 property 1 required
BlockSchema
object
An ORM representation of a block schema.
9 properties 2 required
BlockTypeFilterName
object
Filter by BlockType.name
1 property
BlockType
object
An ORM representation of a block type
10 properties 2 required
BlockSchemaFilterId
object
Filter by BlockSchema.id
1 property
Body_set_block_document_access_api_accounts__account_id__workspaces__workspace_id__block_documents__id__access_put
object
1 property 1 required
BlockDocumentUpdate
object
Data used by the Prefect REST API to update a block document.
3 properties
ObjectActorAccess
object
Data describing an actor with object-level access.
4 properties 4 required
BlockTypeFilter
object
Filter BlockTypes
2 properties
HTTPValidationError
object
1 property
Body_read_block_documents_api_accounts__account_id__workspaces__workspace_id__block_documents_filter_post
object
7 properties
ReplaceBlockDocumentAccess
object
Data used to replace the existing deployment access.
4 properties 2 required
prefect_cloud__orion__schemas__filters__Operator
string
Operators for combining filter criteria.
BlockTypeFilterSlug
object
Filter by BlockType.slug
1 property
BlockDocumentFilterIsAnonymous
object
Filter by BlockDocument.isanonymous.
1 property
BlockDocumentCreate
object
Data used by the Prefect REST API to create a block document.
5 properties 2 required
BlockSchemaFilterVersion
object
Filter by BlockSchema.capabilities
1 property
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-block-documents-api-openapi.yml Raw ↑

Other APIs Prefect publishes across the network.

Prefect Server REST API
Prefect Python SDK
Prefect Account Billing API
Prefect Account Images API
Prefect Account Memberships API
Prefect Account Roles API
Prefect Account SSO API
Prefect Accounts API
Prefect AI API
Prefect Artifacts API
Prefect Asset Publications API
Prefect Asset Subscriptions API
Where this information came from

This is an independent, third-party profile of Prefect Block documents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.