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 Work Queues API

Interact with a Workspace's Work Queues.

Prefect Work Queues 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 Queues. 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 8 paths, and defines 33 schemas. It is described by OpenAPI 3.2.0, at version 0.8.4.

10 operations 8 paths 33 schemas 1 DELETE3 GET1 PATCH5 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 8 paths, the API surfaces 10 operations — 1 DELETE, 3 GET, 1 PATCH, 5 POST. Each is listed below with its method, path, parameters, and response codes.

Work Queues 10

Interact with a Workspace's Work Queues.

POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/
Create Work Queue
create_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__post 3 params body → 201422
PATCH
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}
Update Work Queue
update_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__patch 4 params body → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}
Read Work Queue
read_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get 4 params → 200422
DELETE
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}
Delete Work Queue
delete_work_queue_api_accounts__account_id__workspaces__workspace_id__work_queues__id__delete 4 params → 204422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/name/{name}
Read Work Queue By Name
read_work_queue_by_name_api_accounts__account_id__workspaces__workspace_id__work_queues_name__name__get 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/get_runs
Read Work Queue Runs
read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post 5 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/filter
Read Work Queues
read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post 3 params body → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/paginate
Paginate Work Queues
paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post 3 params body → 200422
GET
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/status
Read Work Queue Status
read_work_queue_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__status_get 4 params → 200422
POST
/api/accounts/{account_id}/workspaces/{workspace_id}/work_queues/{id}/concurrency_status
Read Work Queue Concurrency Status
read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post 4 params body → 200422

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are FlowRunResponse (39 properties), StateDetails (18 properties), WorkPool (17 properties), WorkQueueResponse (17 properties). Each schema is shown below with its type and property counts.

WorkQueueCreate
object
Data used by the Prefect REST API to create a work queue.
6 properties 1 required
CreatedBy
object
3 properties
Body_read_work_queue_concurrency_status_api_accounts__account_id__workspaces__workspace_id__work_queues__id__concurrency_status_post
object
2 properties
WorkQueueResponse
object
17 properties 1 required
WorkQueuePaginatedResponse
object
5 properties 5 required
Body_read_work_queue_runs_api_accounts__account_id__workspaces__workspace_id__work_queues__id__get_runs_post
object
2 properties
StateType
string
Enumeration of state types.
WorkPoolStorageConfiguration
object
A representation of a work pool's storage configuration
3 properties
WorkPool
object
An ORM representation of a work pool
17 properties 3 required
FlowRunSlotSummary
object
Summary of a flow run holding a concurrency slot.
7 properties 7 required
WorkQueueStatusDetail
object
4 properties 2 required
StateDetails
object
18 properties
WorkQueueFilterName
object
Filter by WorkQueue.name.
2 properties
Body_paginate_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_paginate_post
object
3 properties
WorkPoolStatus
string
Enumeration of work pool statuses.
WorkQueueConcurrencyStatusPage
object
Paginated concurrency status for a single work queue.
7 properties 7 required
WorkQueueUpdate
object
Data used by the Orion API to update a work queue.
7 properties
FlowRunResponse
object
39 properties 1 required
FlowRunPolicy
object
Defines of how a flow run should retry.
7 properties
WorkQueueFilterId
object
Filter by WorkQueue.id.
1 property
WorkQueueHealthPolicy
object
2 properties
WorkQueueFilterUpdatedBy
object
Filter by WorkQueue.updatedby.
4 properties
WorkQueueStatus
string
Enumeration of work queue statuses.
HTTPValidationError
object
1 property
WorkQueueFilter
object
Filter work queues. Only work queues matching all criteria will be returned
5 properties
UpdatedBy
object
3 properties
VersionInfo
object
2 properties 2 required
State
object
Represents the state of a run.
7 properties 1 required
prefect_cloud__orion__schemas__filters__Operator
string
Operators for combining filter criteria.
QueueFilter
object
Filter criteria definition for a work queue.
2 properties
WorkQueueFilterCreatedBy
object
Filter by WorkQueue.createdby.
4 properties
Body_read_work_queues_api_accounts__account_id__workspaces__workspace_id__work_queues_filter_post
object
3 properties
ValidationError
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

prefect-work-queues-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 Work Queues 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.