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

The UI API from Prefect — 10 operation(s) for ui.

Prefect UI 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 UI. 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 10 operations across 10 paths, and defines 94 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

10 operations 10 paths 94 schemas 10 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 10

Across 10 paths, the API surfaces 10 operations — 10 POST. Each is listed below with its method, path, parameters, and response codes.

UI 10
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
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history
Read Flow Run History
read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/history-v2
Read Flow Run History V2
read_flow_run_history_v2_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_v2_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flow_runs/count-task-runs
Count Task Runs By Flow Run
count_task_runs_by_flow_run_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_count_task_runs_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/dashboard/counts
Read Dashboard Task Run Counts
read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/count
Read Task Run Counts By State
read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate
Validate Obj
validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/schemas/validate_schema
Validate Schema
validate_schema_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_schema_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/work_pools/count-flow-runs
Count Flow Runs By Work Pool
count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post 3 params body → 200422

Schemas 94

The contract defines 94 schemas that model the data the API accepts and returns. The most detailed are FlowRunFilter (20 properties), DeploymentFilter (17 properties), TaskRunFilter (10 properties), CountByState (9 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
Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post
object
1 property 1 required
SimpleFlowRun
object
5 properties 5 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
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
Body_read_task_run_counts_by_state_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_count_post
object
4 properties
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
CountByState
object
9 properties
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
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
Body_read_dashboard_task_run_counts_api_accounts__account_id__workspaces__workspace_id__ui_task_runs_dashboard_counts_post
object
6 properties 1 required
WorkPoolFilterPaused
object
Filter by WorkPool.ispaused.
1 property
FlowRunHistoryItem
object
5 properties 4 required
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
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
Body_read_flow_run_history_api_accounts__account_id__workspaces__workspace_id__ui_flow_runs_history_post
object
8 properties
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
WorkQueueFilterName
object
Filter by WorkQueue.name.
2 properties
FlowRunSort
string
Defines flow run sorting options.
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
FlowRunHistoryResponse
object
5 properties 5 required
WorkQueueFilterId
object
Filter by WorkQueue.id.
1 property
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
FlowFilterId
object
Filter by Flow.id.
2 properties
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
DashboardTaskRunCount
object
2 properties 2 required
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
Body_validate_obj_api_accounts__account_id__workspaces__workspace_id__ui_schemas_validate_post
object
2 properties 2 required
Body_count_flow_runs_by_work_pool_api_accounts__account_id__workspaces__workspace_id__ui_work_pools_count_flow_runs_post
object
2 properties 1 required
DeploymentFilterPaused
object
Filter by Deployment.paused.
1 property
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
FlowRunFilter
object
Filter flow runs. Only flow runs matching all criteria will be returned
20 properties
WorkPoolFilterUpdatedBy
object
Filter by WorkPool.updatedby.
4 properties
WorkQueueFilterUpdatedBy
object
Filter by WorkQueue.updatedby.
4 properties
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.
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 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-ui-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 UI 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.