Prefect Flow Runs API
Interact with a Workspace's Flow Runs.
Prefect Flow Runs 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 Flow Runs. 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 27 operations across 24 paths, and defines 137 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.
27 operations
24 paths
137 schemas
2 DELETE7 GET2 PATCH16 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 27
Across 24 paths, the API surfaces 27 operations — 2 DELETE, 7 GET, 2 PATCH, 16 POST. Each is listed below with its method, path, parameters, and response codes.
Flow Runs 27
Interact with a Workspace's Flow Runs.
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/
Create Flow Run
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/filter
Read Flow Runs
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/filter-minimal
Read Flow Runs Minimal
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}
Update Flow Run
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}
Read Flow Run
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}
Delete Flow Run
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/count
Count Flow Runs
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/lateness
Average Flow Run Lateness
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/history
Flow Run History
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/graph
Read Flow Run Graph V1
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/graph-v2
Read Flow Run Graph V2
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/artifacts
Get Flow Run Artifacts
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/resume
Resume Flow Run
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/bulk_delete
Bulk Delete Flow Runs
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/bulk_set_state
Bulk Set Flow Run State
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/set_state
Set Flow Run State
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input
Create Flow Run Input
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input/filter
Filter Flow Run Input
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input/{key}
Read Flow Run Input
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/input/{key}
Delete Flow Run Input
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/paginate
Paginate Flow Runs
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/labels
Update Flow Run Labels
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/assets/materializations
Get Flow Run Materializations
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/flow_runs/{id}/assets/references
Get Flow Run References
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history
Read Flow Run History
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history-v2
Read Flow Run History V2
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/count-task-runs
Count Task Runs By Flow Run
Schemas 137
The contract defines 137 schemas that model the data the API accepts and returns. The most detailed are FlowRunResponse (39 properties), MinimalFlowRun (38 properties), FlowRunFilter (20 properties), StateDetails (18 properties). Each schema is shown below with its type and property counts.
WorkPoolFilterType
object
Filter by WorkPool.type.
1 property
Body_flow_run_history_api_accounts__account_id__workspaces__workspace_id__flow_runs_history_post
object
9 properties
3 required
Body_resume_flow_run_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__resume_post
object
1 property
FlowRunFilterTags
object
Filter by FlowRun.tags.
4 properties
CreatedBy
object
3 properties
StateWaitDetails
object
Details associated with a WAIT state transition.
3 properties
1 required
WorkQueue
object
An ORM representation of a work queue
15 properties
1 required
SimpleFlowRun
object
5 properties
5 required
FlowFilterCreatedBy
object
Filter by Flow.createdby.
4 properties
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
FlowRunBulkSetStateResponse
object
Response from bulk flow run state change operation.
1 property
WorkPool
object
An ORM representation of a work pool
17 properties
3 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
StateAcceptDetails
object
Details associated with an ACCEPT state transition.
1 property
StateRejectDetails
object
Details associated with a REJECT state transition.
2 properties
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
SetStateStatus
string
Enumerates return statuses for setting run states.
Body_create_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_post
object
3 properties
2 required
WorkPoolFilterId
object
Filter by WorkPool.id.
1 property
State
object
Represents the state of a run.
7 properties
1 required
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
StateCreate
object
Data used by the Orion API to create a new state.
5 properties
1 required
FlowRunFilterStateName
object
2 properties
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
FlowRunOrchestrationResult
object
Result for a single flow run in a bulk state operation.
4 properties
3 required
TaskRunFilterEndTime
object
Filter by TaskRun.endtime.
3 properties
FlowRunPaginationResponse
object
5 properties
5 required
Body_read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post
object
9 properties
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
Body_count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post
object
1 property
1 required
DeploymentStatus
string
Enumeration of deployment statuses.
FlowRunFilterWorkQueueId
object
Filter by FlowRun.workqueueid.
3 properties
FlowRunFilterDeploymentVersionId
object
Filter by FlowRun.deploymentversionid.
3 properties
1 required
Edge
object
1 property
1 required
WorkPoolFilterPaused
object
Filter by WorkPool.ispaused.
1 property
FlowRunHistoryItem
object
5 properties
4 required
FlowRunFilterWorkQueueName
object
Filter by FlowRun.workqueuename.
3 properties
CancelledBy
object
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
FlowRunPolicy
object
Defines of how a flow run should retry.
7 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
HistoryResponse
object
Represents a history of aggregation states over an interval
3 properties
3 required
Body_count_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_count_post
object
6 properties
MaterializationEvent
object
Represents a single asset materialization event. Captures a historical snapshot of an asset materialization, including the asset's properties at the time of ma…
14 properties
5 required
FlowRunFilterNextScheduledStartTime
object
Filter by FlowRun.nextscheduledstarttime.
2 properties
WorkQueueFilterCreatedBy
object
Filter by WorkQueue.createdby.
4 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
Body_bulk_delete_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_delete_post
object
2 properties
1 required
Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post
object
8 properties
FlowRunCreate
object
Data used by the Orion API to create a flow run.
16 properties
1 required
DeploymentFilter
object
Filter for deployments. Only deployments matching all criteria will be returned.
17 properties
FlowRunInput
object
7 properties
3 required
TaskRunFilterStateName
object
1 property
Node
object
10 properties
10 required
DependencyResult
object
10 properties
10 required
Body_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__set_state_post
object
3 properties
1 required
DeploymentFilterBranch
object
Filter by Deployment.branch.
3 properties
FlowRunFilterStateType
object
Filter by FlowRun.statetype.
2 properties
WorkPoolFilterStatus
object
Filter by WorkPool.status.
1 property
GraphState
object
4 properties
4 required
WorkPoolStorageConfiguration
object
A representation of a work pool's storage configuration
3 properties
DeploymentFilterId
object
Filter by Deployment.id.
2 properties
TaskRunFilterId
object
Filter by TaskRun.id.
1 property
TaskRunFilterFlowRunId
object
Filter by TaskRun.flowrunid.
3 properties
Body_bulk_set_flow_run_state_api_accounts__account_id__workspaces__workspace_id__flow_runs_bulk_set_state_post
object
5 properties
2 required
WorkQueueFilterName
object
Filter by WorkQueue.name.
2 properties
FlowRunSort
string
Defines flow run sorting options.
FlowRunUpdate
object
Data used by the Orion API to update a flow run.
7 properties
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
HistoryResponseState
object
Represents a single state's history over an interval.
5 properties
5 required
MinimalFlowRun
object
An ORM representation a flow run for use by the UI. This representation does not include state data, to improve performance of flow run-related APIs.
38 properties
1 required
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
FlowRunHistoryResponse
object
5 properties
5 required
WorkQueueFilterId
object
Filter by WorkQueue.id.
1 property
Body_average_flow_run_lateness_api_accounts__account_id__workspaces__workspace_id__flow_runs_lateness_post
object
6 properties
Body_read_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_post
object
9 properties
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
WorkQueueStatus
string
Enumeration of work queue statuses.
FlowFilterId
object
Filter by Flow.id.
2 properties
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
UpdatedBy
object
3 properties
Body_paginate_flow_runs_api_accounts__account_id__workspaces__workspace_id__flow_runs_paginate_post
object
9 properties
QueueFilter
object
Filter criteria definition for a work queue.
2 properties
FlowFilterName
object
Filter by Flow.name.
2 properties
TaskRunFilterSubFlowRuns
object
Filter by TaskRun.subflowrun.
1 property
DeploymentFilterUpdatedBy
object
Filter by Deployment.updatedby.
4 properties
DeploymentFilterTags
object
Filter by Deployment.tags.
4 properties
BulkDeleteResponse
object
Response from a bulk deletion operation.
1 property
Artifact
object
10 properties
Graph
object
6 properties
6 required
OrchestrationResult
object
A container for the output of state orchestration.
3 properties
3 required
DeploymentFilterPaused
object
Filter by Deployment.paused.
1 property
FlowRunFilterName
object
Filter by FlowRun.name.
2 properties
StateAbortDetails
object
Details associated with an ABORT state transition.
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
StateDetails
object
18 properties
DeploymentFilterBase
object
Filter by Deployment.base.
2 properties
TaskRunFilterState
object
3 properties
FlowRunFilterParentFlowRunId
object
2 properties
GraphArtifact
object
6 properties
4 required
FlowRunFilter
object
Filter flow runs. Only flow runs matching all criteria will be returned
20 properties
Body_read_flow_runs_minimal_api_accounts__account_id__workspaces__workspace_id__flow_runs_filter_minimal_post
object
9 properties
WorkPoolFilterUpdatedBy
object
Filter by WorkPool.updatedby.
4 properties
FlowRunResponse
object
39 properties
1 required
WorkQueueFilterUpdatedBy
object
Filter by WorkQueue.updatedby.
4 properties
Body_filter_flow_run_input_api_accounts__account_id__workspaces__workspace_id__flow_runs__id__input_filter_post
object
3 properties
1 required
TaskRunFilterStartTime
object
Filter by TaskRun.starttime.
3 properties
HTTPValidationError
object
1 property
WorkQueueFilter
object
Filter work queues. Only work queues matching all criteria will be returned
5 properties
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.
TaskRunResult
object
Represents a task run result input to another task run.
2 properties
1 required
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 properties
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
ReferenceEvent
object
Represents a single asset reference event. Captures when an asset was referenced/read during a run, including the asset's properties at the time of reference (…
11 properties
4 required
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
More from Prefect 12
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
#Flow Runs
Where this information came from
This is an independent, third-party profile of Prefect Flow Runs 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.