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

Interact with a Workspace's Flows.

Prefect Flows 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 Flows. 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 9 paths, and defines 88 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

11 operations 9 paths 88 schemas 1 DELETE2 GET1 PATCH7 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 9 paths, the API surfaces 11 operations — 1 DELETE, 2 GET, 1 PATCH, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Flows 11

Interact with a Workspace's Flows.

POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/
Create Flow
create_flow_api_accounts__account_id__workspaces__workspace_id__flows__post 3 params body → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}
Update Flow
update_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__patch 4 params body → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}
Read Flow
read_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__get 4 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}
Delete Flow
delete_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__delete 4 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/count
Count Flows
count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post 3 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/name/{name}
Read Flow By Name
read_flow_by_name_api_accounts__account_id__workspaces__workspace_id__flows_name__name__get 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/filter
Read Flows
read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/bulk_delete
Bulk Delete Flows
bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/paginate
Paginate Flows
paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/count-deployments
Count Deployments By Flow
count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/next-runs
Next Runs By Flow
next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post 3 params body → 200422

Schemas 88

The contract defines 88 schemas that model the data the API accepts and returns. The most detailed are FlowRunFilter (20 properties), DeploymentFilter (17 properties), TaskRunFilter (10 properties), Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post (8 properties). Each schema is shown below with its type and property counts.

WorkPoolFilterType
object
Filter by WorkPool.type.
1 property
FlowRunFilterTags
object
Filter by FlowRun.tags.
4 properties
CreatedBy
object
3 properties
Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post
object
1 property 1 required
FlowFilterCreatedBy
object
Filter by Flow.createdby.
4 properties
SimpleNextFlowRun
object
6 properties 6 required
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
FlowPaginationResponse
object
5 properties 5 required
FlowRunFilterEndTime
object
Filter by FlowRun.endtime.
3 properties
DeploymentOrFlowNameFilter
object
Filter by Deployment.name or Flow.name with a single input string for ilike filtering.
1 property
FlowRunFilterDeploymentVersionInfo
object
Filter by FlowRun.deploymentversioninfo.
3 properties 1 required
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
WorkPoolFilterId
object
Filter by WorkPool.id.
1 property
DeploymentFilterCreatedBy
object
Filter by Deployment.createdby.
4 properties
FlowRunFilterId
object
Filter by FlowRun.id.
2 properties
WorkPoolFilter
object
8 properties
TaskRunFilterExpectedStartTime
object
Filter by TaskRun.expectedstarttime.
2 properties
FlowRunFilterStateName
object
2 properties
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
TaskRunFilterEndTime
object
Filter by TaskRun.endtime.
3 properties
FlowSort
string
Defines flow sorting options.
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
DeploymentStatus
string
Enumeration of deployment statuses.
FlowRunFilterWorkQueueId
object
Filter by FlowRun.workqueueid.
3 properties
FlowRunFilterDeploymentVersionId
object
Filter by FlowRun.deploymentversionid.
3 properties 1 required
WorkPoolFilterPaused
object
Filter by WorkPool.ispaused.
1 property
FlowRunFilterWorkQueueName
object
Filter by FlowRun.workqueuename.
3 properties
FlowFilterTags
object
Filter by Flow.tags.
3 properties
DeploymentFilterWorkQueueId
object
Filter by Deployment.workqueueid
1 property
DeploymentFilterName
object
Filter by Deployment.name.
2 properties
TaskRunFilter
object
Filter task runs. Only task runs matching all criteria will be returned
10 properties
FlowFilterDeployment
object
Filter by flows by deployment
2 properties
TaskRunFilterName
object
Filter by TaskRun.name.
2 properties
FlowRunFilterNextScheduledStartTime
object
Filter by FlowRun.nextscheduledstarttime.
2 properties
TaskRunFilterTags
object
Filter by TaskRun.tags.
3 properties
TaskRunFilterStateType
object
Filter by TaskRun.statetype.
1 property
DeploymentFilterConcurrencyLimit
object
DEPRECATED: Prefer Deployment.concurrencylimitid over Deployment.concurrencylimit.
3 properties
Flow
object
An ORM representation of flow data.
8 properties 1 required
DeploymentFilter
object
Filter for deployments. Only deployments matching all criteria will be returned.
17 properties
TaskRunFilterStateName
object
1 property
DeploymentFilterBranch
object
Filter by Deployment.branch.
3 properties
FlowRunFilterStateType
object
Filter by FlowRun.statetype.
2 properties
WorkPoolFilterStatus
object
Filter by WorkPool.status.
1 property
Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post
object
1 property 1 required
DeploymentFilterId
object
Filter by Deployment.id.
2 properties
TaskRunFilterId
object
Filter by TaskRun.id.
1 property
TaskRunFilterFlowRunId
object
Filter by TaskRun.flowrunid.
3 properties
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
FlowFilterId
object
Filter by Flow.id.
2 properties
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
UpdatedBy
object
3 properties
FlowFilterName
object
Filter by Flow.name.
2 properties
TaskRunFilterSubFlowRuns
object
Filter by TaskRun.subflowrun.
1 property
DeploymentFilterTags
object
Filter by Deployment.tags.
4 properties
DeploymentFilterUpdatedBy
object
Filter by Deployment.updatedby.
4 properties
BulkDeleteResponse
object
Response from a bulk deletion operation.
1 property
Body_read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post
object
8 properties
DeploymentFilterPaused
object
Filter by Deployment.paused.
1 property
Body_bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post
object
2 properties 1 required
FlowRunFilterName
object
Filter by FlowRun.name.
2 properties
StateType
string
Enumeration of state types.
WorkPoolFilterCreatedBy
object
Filter by WorkPool.createdby.
4 properties
FlowFilter
object
Filter for flows. Only flows matching all criteria will be returned.
7 properties
DeploymentFilterIsScheduleActive
object
Legacy filter to filter by Deployment.isscheduleactive which is always the opposite of Deployment.paused.
1 property
WorkPoolFilterName
object
Filter by WorkPool.name.
2 properties
DeploymentFilterBase
object
Filter by Deployment.base.
2 properties
TaskRunFilterState
object
3 properties
FlowRunFilterParentFlowRunId
object
2 properties
Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post
object
8 properties
FlowRunFilter
object
Filter flow runs. Only flow runs matching all criteria will be returned
20 properties
WorkPoolFilterUpdatedBy
object
Filter by WorkPool.updatedby.
4 properties
TaskRunFilterStartTime
object
Filter by TaskRun.starttime.
3 properties
HTTPValidationError
object
1 property
VersionInfo
object
2 properties 2 required
FlowRunFilterFlowVersion
object
Filter by FlowRun.flowversion.
1 property
prefect_cloud__orion__schemas__filters__Operator
string
Operators for combining filter criteria.
FlowCreate
object
Data used by the Orion API to create a flow.
3 properties 1 required
FlowUpdate
object
Data used by the Prefect REST API to update a flow.
2 properties
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 properties
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
Body_count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post
object
5 properties
DeploymentFilterStatus
object
Filter by Deployment.status.
1 property
ValidationError
object
3 properties 3 required
DeploymentFilterWorkQueueName
object
Filter by Deployment.workqueuename.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-flows-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 Flows 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.