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 Workspaces API

Interact with Prefect Cloud Workspaces.

Prefect Workspaces 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 Workspaces. 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 11 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

11 operations 8 paths 13 schemas 1 DELETE4 GET2 PATCH4 POST

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 11

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

Workspaces 11

Interact with Prefect Cloud Workspaces.

POST
/api/accounts/{account_id}/workspaces/
Create Workspace
create_workspace_api_accounts__account_id__workspaces__post 1 param body → 201422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}
Read Workspace
read_workspace_api_accounts__account_id__workspaces__workspace_id__get 2 params → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}
Update Workspace
update_workspace_api_accounts__account_id__workspaces__workspace_id__patch 2 params body → 204422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}
Delete Workspace
delete_workspace_api_accounts__account_id__workspaces__workspace_id__delete 2 params → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/managed_execution/details
Read Managed Execution Details
read_managed_execution_details_api_accounts__account_id__workspaces__workspace_id__managed_execution_details_get 2 params → 200422
POST
/api/accounts/{account_id}/workspaces/filter
Read Workspaces
read_workspaces_api_accounts__account_id__workspaces_filter_post 1 param body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/transfer
Transfer Workspace
transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post 2 params body → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/validate_transfer
Validate Transfer Workspace
validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post 2 params body → 200422
GET
/api/workspaces/{workspace_id}
Find Workspace Without Account Id
find_workspace_without_account_id_api_workspaces__workspace_id__get 1 param → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/settings
Read Workspace Settings
read_workspace_settings_api_accounts__account_id__workspaces__workspace_id__settings_get 2 params → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/settings
Update Workspace Settings
update_workspace_settings_api_accounts__account_id__workspaces__workspace_id__settings_patch 2 params body → 204422

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Workspace (9 properties), WorkspaceUpdate (4 properties), ValidationError (3 properties), Body_read_workspaces_api_accounts__account_id__workspaces_filter_post (3 properties). Each schema is shown below with its type and property counts.

Workspace
object
An ORM representation of a Workspace
9 properties 3 required
WorkspaceFilterHandle
object
1 property
WorkspaceFilter
object
2 properties
WorkspaceCreate
object
Data used by the api to create a workspace
3 properties 2 required
WorkspaceFilterId
object
1 property
WorkspaceSettingsUpdate
object
Data used by API to update workspace settings
2 properties
Body_validate_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__validate_transfer_post
object
2 properties 1 required
Body_transfer_workspace_api_accounts__account_id__workspaces__workspace_id__transfer_post
object
2 properties 1 required
ValidationError
object
3 properties 3 required
WorkspaceSettings
object
2 properties
HTTPValidationError
object
1 property
Body_read_workspaces_api_accounts__account_id__workspaces_filter_post
object
3 properties
WorkspaceUpdate
object
Data used by the api to update a workspace
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-workspaces-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 Workspaces 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.