Prefect Task Runs API
Interact with a Workspace's Task Runs.
Prefect Task 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 Task 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 14 operations across 12 paths, and defines 111 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.
14 operations
12 paths
111 schemas
1 DELETE4 GET1 PATCH8 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 14
Across 12 paths, the API surfaces 14 operations — 1 DELETE, 4 GET, 1 PATCH, 8 POST. Each is listed below with its method, path, parameters, and response codes.
Task Runs 14
Interact with a Workspace's Task Runs.
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/filter
Read Task Runs
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}
Delete Task Run
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}
Update Task Run
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}
Read Task Run
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/
Create Task Run
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/count
Count Task Runs
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/history
Task Run History
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/artifacts
Get Task Run Artifacts
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/assets/materializations
Get Task Run Materializations
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/assets/references
Get Task Run References
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/{id}/set_state
Set Task Run State
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/task_runs/paginate
Paginate Task Runs
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/dashboard/counts
Read Dashboard Task Run Counts
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/task_runs/count
Read Task Run Counts By State
Schemas 111
The contract defines 111 schemas that model the data the API accepts and returns. The most detailed are TaskRun (27 properties), FlowRunFilter (20 properties), StateDetails (18 properties), DeploymentFilter (17 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
StateWaitDetails
object
Details associated with a WAIT state transition.
3 properties
1 required
FlowFilterCreatedBy
object
Filter by Flow.createdby.
4 properties
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
TaskRunCreate
object
Data used by the Orion API to create a task run
13 properties
2 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
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.
SetStateStatus
string
Enumerates return statuses for setting run states.
CountByState
object
9 properties
WorkPoolFilterId
object
Filter by WorkPool.id.
1 property
Body_set_task_run_state_api_accounts__account_id__workspaces__workspace_id__task_runs__id__set_state_post
object
2 properties
1 required
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
Body_task_run_history_api_accounts__account_id__workspaces__workspace_id__task_runs_history_post
object
7 properties
3 required
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
TaskRunFilterEndTime
object
Filter by TaskRun.endtime.
3 properties
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
TaskRunSort
string
Defines task run sorting options.
DeploymentStatus
string
Enumeration of deployment statuses.
Body_read_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_filter_post
object
7 properties
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
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
FlowRunResult
object
2 properties
1 required
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
TaskRunPolicy
object
Defines of how a task run should retry.
5 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
Body_count_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_count_post
object
4 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_paginate_task_runs_api_accounts__account_id__workspaces__workspace_id__task_runs_paginate_post
object
7 properties
DeploymentFilter
object
Filter for deployments. Only deployments matching all criteria will be returned.
17 properties
TaskRunFilterStateName
object
1 property
Parameter
object
Represents a parameter input to a task run.
2 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
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
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
HistoryResponseState
object
Represents a single state's history over an interval.
5 properties
5 required
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
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
Constant
object
Represents constant input value to a task run.
2 properties
1 required
TaskRunFilterSubFlowRuns
object
Filter by TaskRun.subflowrun.
1 property
DeploymentFilterUpdatedBy
object
Filter by Deployment.updatedby.
4 properties
DeploymentFilterTags
object
Filter by Deployment.tags.
4 properties
Artifact
object
10 properties
OrchestrationResult
object
A container for the output of state orchestration.
3 properties
3 required
TaskRunUpdate
object
Data used by the Orion API to update a task run
1 property
TaskRun
object
An ORM representation of task run data.
27 properties
2 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
DeploymentFilterBase
object
Filter by Deployment.base.
2 properties
TaskRunFilterState
object
3 properties
StateDetails
object
18 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.
TaskRunPaginationResponse
object
5 properties
5 required
TaskRunResult
object
Represents a task run result input to another task run.
2 properties
1 required
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 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
#Task Runs
Where this information came from
This is an independent, third-party profile of Prefect Task 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.