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.
The identity and technical contract details declared by the specification.
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
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Prefect publishes across the network.