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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Prefect

Prefect Work Pools API

The Work Pools API from Prefect — 20 operation(s) for work pools.

Documentation Provider Profile APIs.io OpenAPI GitHub

Prefect Work Pools 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 Work Pools. 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 25 operations across 20 paths, and defines 92 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

25 operations 20 paths 92 schemas 3 DELETE4 GET2 PATCH15 POST1 PUT

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 25

Across 20 paths, the API surfaces 25 operations — 3 DELETE, 4 GET, 2 PATCH, 15 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Work Pools 25
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/configuration/preview
Preview Work Pool Configuration
preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/
Create Work Pool
create_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__post 3 params body → 201422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}
Read Work Pool
read_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get 4 params → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}
Update Work Pool
update_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__patch 4 params body → 204422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}
Delete Work Pool
delete_work_pool_api_accounts__account_id__workspaces__workspace_id__work_pools__name__delete 4 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/filter
Read Work Pools
read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/paginate
Paginate Work Pools
paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/count
Count Work Pools
count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/get_scheduled_flow_runs
Get Scheduled Flow Runs
get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post 4 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/access
Read Work Pool Access
read_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_get 4 params → 200422
PUT
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/access
Set Work Pool Access
set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put 4 params body → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/my-access
Read Actors Work Pool Access
read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues
Create Work Queue
create_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_post 4 params body → 201422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/{name}
Read Work Queue
read_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__get 5 params → 200422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/{name}
Update Work Queue
update_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__patch 5 params body → 204422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/{name}
Delete Work Queue
delete_work_queue_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues__name__delete 5 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/filter
Read Work Queues
read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post 4 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/queues/paginate
Paginate Work Queues
paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post 4 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/heartbeat
Worker Heartbeat
worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post 4 params body → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/filter
Read Workers
read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post 4 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/paginate
Paginate Workers
paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post 4 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/{worker_id}
Read Worker
read_worker_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers__worker_id__get 5 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{work_pool_name}/workers/{name}
Delete Worker
delete_worker_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers__name__delete 5 params → 204422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_pools/{name}/concurrency_status
Read Work Pool Concurrency Status
read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post 4 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 92

The contract defines 92 schemas that model the data the API accepts and returns. The most detailed are FlowRunWithRunTimeField (40 properties), FlowRunFilter (20 properties), StateDetails (18 properties), WorkPoolResponse (18 properties). Each schema is shown below with its type and property counts.

WorkPoolFilterType
object
Filter by WorkPool.type.
1 property
Body_get_scheduled_flow_runs_api_accounts__account_id__workspaces__workspace_id__work_pools__name__get_scheduled_flow_runs_post
object
4 properties
FlowRunFilterTags
object
Filter by FlowRun.tags.
4 properties
CreatedBy
object
3 properties
WorkQueueConcurrencyStatusDetail
object
Concurrency status for a single work queue within a work pool.
6 properties 6 required
WorkQueuePaginatedResponse
object
5 properties 5 required
WorkQueue
object
An ORM representation of a work queue
15 properties 1 required
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
Body_set_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools__name__access_put
object
1 property 1 required
WorkPool
object
An ORM representation of a work pool
17 properties 3 required
Body_paginate_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_paginate_post
object
4 properties
FlowRunFilterEndTime
object
Filter by FlowRun.endtime.
3 properties
FlowRunFilterDeploymentVersionInfo
object
Filter by FlowRun.deploymentversioninfo.
3 properties 1 required
Body_read_actors_work_pool_access_api_accounts__account_id__workspaces__workspace_id__work_pools_my_access_post
object
2 properties
Body_preview_work_pool_configuration_api_accounts__account_id__workspaces__workspace_id__work_pools_configuration_preview_post
object
2 properties 2 required
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
WorkPoolFilterId
object
Filter by WorkPool.id.
1 property
WorkPoolAccessControl
object
A representation of the access control for a deployment.
3 properties
WorkerSort
string
Defines flow sorting options.
State
object
Represents the state of a run.
7 properties 1 required
Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_paginate_post
object
3 properties
FlowRunFilterId
object
Filter by FlowRun.id.
2 properties
WorkPoolFilter
object
8 properties
FlowRunFilterStateName
object
2 properties
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
WorkerStatus
string
Enumeration of worker statuses.
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
WorkerFilterStatus
object
Filter by Worker.status.
2 properties
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
CancelledBy
object
3 properties
WorkPoolCreate
object
Data used by the Orion API to create a work pool.
7 properties 1 required
FlowRunPolicy
object
Defines of how a flow run should retry.
7 properties
Worker
object
An ORM representation of a worker
11 properties 2 required
ObjectActorAccess
object
Data describing an actor with object-level access.
4 properties 4 required
WorkPoolConcurrencyStatusPage
object
Paginated concurrency status for a work pool.
8 properties 8 required
WorkQueueFilterCreatedBy
object
Filter by WorkQueue.createdby.
4 properties
FlowRunFilterNextScheduledStartTime
object
Filter by FlowRun.nextscheduledstarttime.
2 properties
WorkerFilterLastHeartbeatTime
object
Filter by Worker.lastheartbeattime.
2 properties
WorkerFlowRunResponse
object
3 properties 3 required
Flow
object
An ORM representation of flow data.
8 properties 1 required
FlowRunWithRunTimeField
object
40 properties 1 required
Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__queues_filter_post
object
3 properties
WorkQueueResponse
object
17 properties 1 required
Body_count_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_count_post
object
1 property
FlowRunFilterStateType
object
Filter by FlowRun.statetype.
2 properties
WorkPoolFilterStatus
object
Filter by WorkPool.status.
1 property
WorkPoolStorageConfiguration
object
A representation of a work pool's storage configuration
3 properties
FlowRunSlotSummary
object
Summary of a flow run holding a concurrency slot.
7 properties 7 required
WorkQueueFilterName
object
Filter by WorkQueue.name.
2 properties
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
WorkQueueFilterId
object
Filter by WorkQueue.id.
1 property
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
WorkQueueStatus
string
Enumeration of work queue statuses.
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
UpdatedBy
object
3 properties
QueueFilter
object
Filter criteria definition for a work queue.
2 properties
WorkerPaginatedResponse
object
5 properties 5 required
Body_read_work_pool_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_pools__name__concurrency_status_post
object
3 properties
WorkQueueCreate
object
Data used by the Prefect REST API to create a work queue.
6 properties 1 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
Body_read_workers_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_filter_post
object
4 properties
FlowRunFilterName
object
Filter by FlowRun.name.
2 properties
StateType
string
Enumeration of state types.
Body_worker_heartbeat_api_accounts__account_id__workspaces__workspace_id__work_pools__work_pool_name__workers_heartbeat_post
object
4 properties 1 required
WorkPoolFilterCreatedBy
object
Filter by WorkPool.createdby.
4 properties
WorkPoolFilterName
object
Filter by WorkPool.name.
2 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
WorkPoolPaginationResponse
object
5 properties 5 required
WorkPoolFilterUpdatedBy
object
Filter by WorkPool.updatedby.
4 properties
WorkQueueUpdate
object
Data used by the Orion API to update a work queue.
7 properties
WorkerFilterName
object
Filter by Worker.name.
3 properties
WorkQueueFilterUpdatedBy
object
Filter by WorkQueue.updatedby.
4 properties
Body_read_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_filter_post
object
5 properties
ReplaceWorkPoolAccess
object
Data used to replace the existing work pool access.
6 properties 3 required
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.
WorkPoolResponse
object
18 properties 3 required
WorkPoolUpdate
object
Data used by the Prefect REST API to update a work pool.
5 properties
Body_paginate_work_pools_api_accounts__account_id__workspaces__workspace_id__work_pools_paginate_post
object
5 properties
WorkPoolSort
string
Defines work pool sorting options.
WorkerFilter
object
4 properties
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-work-pools-api-openapi.yml Raw ↑

Other APIs Prefect publishes across the network.

Prefect Server REST API
AE Profile APIs.io
Prefect Python SDK
AE Profile APIs.io
Prefect Account Billing API
AE Profile APIs.io
Prefect Account Images API
AE Profile APIs.io
Prefect Account Memberships API
AE Profile APIs.io
Prefect Account Roles API
AE Profile APIs.io
Prefect Account SSO API
AE Profile APIs.io
Prefect Accounts API
AE Profile APIs.io
Prefect AI API
AE Profile APIs.io
Prefect Artifacts API
AE Profile APIs.io
Prefect Asset Publications API
AE Profile APIs.io
Prefect Asset Subscriptions API
AE Profile APIs.io
#Work Pools
← Back to P APIs
API Details
ID
prefect:prefect-work-pools-api
Docs
https://docs.prefect.io/v3/api-ref/rest-api
Provider
Prefect
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=prefect-work-pools-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/prefect-work-pools-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Prefect Work Pools 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.