Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/prefect-flows-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Prefect Cloud Account Billing Flows API
description: Prefect Cloud REST API documentation.
version: 0.8.4
tags:
- name: Flows
description: Interact with a Workspace's Flows.
externalDocs:
description: Write and run flows
url: https://docs.prefect.io/v3/develop/write-flows
paths:
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/:
post:
tags:
- Flows
summary: Create Flow
description: 'Gracefully creates a new flow from the provided schema. If a flow with the
same name already exists, the existing flow is returned.
Required workspace scopes: `run_flows`'
operationId: create_flow_api_accounts__account_id__workspaces__workspace_id__flows__post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FlowCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Flow'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/{id}:
patch:
tags:
- Flows
summary: Update Flow
description: 'Updates a flow.
Required workspace scopes: `run_flows`'
operationId: update_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__patch
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The flow id
title: Id
description: The flow id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FlowUpdate'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
get:
tags:
- Flows
summary: Read Flow
description: 'Get a flow by id.
Required workspace scopes: `see_flows`'
operationId: read_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__get
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The flow id
title: Id
description: The flow id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Flow'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Flows
summary: Delete Flow
description: 'Delete a flow by id.
Required workspace scopes: `manage_flows`'
operationId: delete_flow_api_accounts__account_id__workspaces__workspace_id__flows__id__delete
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The flow id
title: Id
description: The flow id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/count:
post:
tags:
- Flows
summary: Count Flows
description: 'Count flows.
Required workspace scopes: `see_flows`'
operationId: count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_count_flows_api_accounts__account_id__workspaces__workspace_id__flows_count_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Count Flows Api Accounts Account Id Workspaces Workspace Id Flows Count Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/name/{name}:
get:
tags:
- Flows
summary: Read Flow By Name
description: 'Get a flow by name.
Required workspace scopes: `see_flows`'
operationId: read_flow_by_name_api_accounts__account_id__workspaces__workspace_id__flows_name__name__get
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: name
in: path
required: true
schema:
type: string
description: The name of the flow
title: Name
description: The name of the flow
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Flow'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/filter:
post:
tags:
- Flows
summary: Read Flows
description: 'Query for flows.
Required workspace scopes: `see_flows`'
operationId: read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_read_flows_api_accounts__account_id__workspaces__workspace_id__flows_filter_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Flow'
title: Response Read Flows Api Accounts Account Id Workspaces Workspace Id Flows Filter Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/bulk_delete:
post:
tags:
- Flows
summary: Bulk Delete Flows
description: 'Bulk delete flows using a filter.
This endpoint soft-deletes flows matching the provided filter criteria,
then hard-deletes their associated deployments.
Flow runs are soft-deleted asynchronously in the background.
Associated automations are cleaned up asynchronously in the background.
If ANY deployment for a flow is unauthorized, the entire request fails
and nothing is deleted.
Required workspace scopes: `manage_flows`'
operationId: bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_bulk_delete_flows_api_accounts__account_id__workspaces__workspace_id__flows_bulk_delete_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/BulkDeleteResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/flows/paginate:
post:
tags:
- Flows
summary: Paginate Flows
description: 'Pagination query for flows.
Required workspace scopes: `see_flows`'
operationId: paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_paginate_flows_api_accounts__account_id__workspaces__workspace_id__flows_paginate_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/FlowPaginationResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/count-deployments:
post:
tags:
- Flows
summary: Count Deployments By Flow
description: 'Get deployment counts by flow id.
Required workspace scopes: `see_flows`'
operationId: count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post
parameters:
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
type: integer
propertyNames:
format: uuid
title: Response Count Deployments By Flow Api Accounts Account Id Workspaces Workspace Id Ui Flows Count Deployments Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/ui/flows/next-runs:
post:
tags:
- Flows
summary: Next Runs By Flow
description: 'Get the next flow run by flow id.
Required workspace scopes: `see_flows`'
operationId: next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post
parameters:
- name: workspace_id
in: path
required: true
schema:
type: string
format: uuid
title: Workspace Id
- name: account_id
in: path
required: true
schema:
type: string
format: uuid
title: Account Id
- name: x-prefect-api-version
in: header
required: false
schema:
type: string
title: X-Prefect-Api-Version
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Body_next_runs_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_next_runs_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: object
additionalProperties:
anyOf:
- $ref: '#/components/schemas/SimpleNextFlowRun'
- type: 'null'
propertyNames:
format: uuid
title: Response Next Runs By Flow Api Accounts Account Id Workspaces Workspace Id Ui Flows Next Runs Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
WorkPoolFilterType:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of work pool types to include
additionalProperties: false
type: object
title: WorkPoolFilterType
description: Filter by `WorkPool.type`.
FlowRunFilterTags:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
all_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: All
description: A list of tags. Flow runs will be returned only if their tags are a superset of the list
examples:
- - tag-1
- tag-2
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of tags. Flow runs will be returned if their tags contain any of the tags in the list
examples:
- - tag-1
- tag-2
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without tags
additionalProperties: false
type: object
title: FlowRunFilterTags
description: Filter by `FlowRun.tags`.
CreatedBy:
properties:
id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Id
description: The id of the creator of the object.
type:
anyOf:
- type: string
- type: 'null'
title: Type
description: The type of the creator of the object.
display_value:
anyOf:
- type: string
- type: 'null'
title: Display Value
description: The display value for the creator.
type: object
title: CreatedBy
Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post:
properties:
flow_ids:
items:
type: string
format: uuid
type: array
title: Flow Ids
max_items: 200
type: object
required:
- flow_ids
title: Body_count_deployments_by_flow_api_accounts__account_id__workspaces__workspace_id__ui_flows_count_deployments_post
FlowFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flows without a creator
additionalProperties: false
type: object
title: FlowFilterCreatedBy
description: Filter by `Flow.created_by`.
SimpleNextFlowRun:
properties:
id:
type: string
format: uuid
title: Id
description: The flow run id.
flow_id:
type: string
format: uuid
title: Flow Id
description: The flow id.
name:
type: string
title: Name
description: The flow run name
state_name:
type: string
title: State Name
description: The state name.
state_type:
$ref: '#/components/schemas/StateType'
description: The state type.
next_scheduled_start_time:
type: string
format: date-time
title: Next Scheduled Start Time
description: The next scheduled start time
type: object
required:
- id
- flow_id
- name
- state_name
- state_type
- next_scheduled_start_time
title: SimpleNextFlowRun
FlowRunFilterIdempotencyKey:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of flow run idempotency keys to include
not_any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Not Any
description: A list of flow run idempotency keys to exclude
additionalProperties: false
type: object
title: FlowRunFilterIdempotencyKey
description: Filter by FlowRun.idempotency_key.
FlowRunFilterState:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
type:
anyOf:
- $ref: '#/components/schemas/FlowRunFilterStateType'
- type: 'null'
description: Filter criteria for `FlowRun.state_type`
name:
anyOf:
- $ref: '#/components/schemas/FlowRunFilterStateName'
- type: 'null'
description: Filter criteria for `FlowRun.state_name`
additionalProperties: false
type: object
title: FlowRunFilterState
FlowPaginationResponse:
properties:
results:
items:
$ref: '#/components/schemas/Flow'
type: array
title: Results
count:
type: integer
title: Count
limit:
type: integer
title: Limit
pages:
type: integer
title: Pages
page:
type: integer
title: Page
type: object
required:
- results
- count
- limit
- pages
- page
title: FlowPaginationResponse
FlowRunFilterEndTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include flow runs ending at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include flow runs ending at or after this time
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only return flow runs without an end time
additionalProperties: false
type: object
title: FlowRunFilterEndTime
description: Filter by `FlowRun.end_time`.
DeploymentOrFlowNameFilter:
properties:
like_:
anyOf:
- type: string
- type: 'null'
title: Like
description: A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.
examples:
- example
additionalProperties: false
type: object
title: DeploymentOrFlowNameFilter
description: Filter by `Deployment.name` or `Flow.name` with a single input string for ilike filtering.
FlowRunFilterDeploymentVersionInfo:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
deployment_id:
type: string
format: uuid
title: Deployment Id
description: The deployment id to filter by
any_:
anyOf:
- items:
$ref: '#/components/schemas/VersionInfo'
type: array
- type: 'null'
title: Any
description: A list of flow run deployment version infos to include
additionalProperties: false
type: object
required:
- deployment_id
title: FlowRunFilterDeploymentVersionInfo
description: Filter by `FlowRun.deployment_version_info`.
FlowRunFilterFlowId:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of flow run flow ids to include
additionalProperties: false
type: object
title: FlowRunFilterFlowId
description: Filter by `FlowRun.flow_id`.
WorkPoolStatus:
type: string
enum:
- READY
- NOT_READY
- PAUSED
title: WorkPoolStatus
description: Enumeration of work pool statuses.
WorkPoolFilterId:
properties:
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of work pool ids to include
additionalProperties: false
type: object
title: WorkPoolFilterId
description: Filter by `WorkPool.id`.
DeploymentFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include deployments without a creator
additionalProperties: false
type: object
title: DeploymentFilterCreatedBy
description: Filter by `Deployment.created_by`.
FlowRunFilterId:
properties:
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of flow run ids to include
not_any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Not Any
description: A list of flow run ids to exclude
additionalProperties: false
type: object
title: FlowRunFilterId
description: Filter by FlowRun.id.
WorkPoolFilter:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterId'
- type: 'null'
description: Filter criteria for `WorkPool.id`
name:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterName'
- type: 'null'
description: Filter criteria for `WorkPool.name`
type:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterType'
- type: 'null'
description: Filter criteria for `WorkPool.type`
paused:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterPaused'
- type: 'null'
description: Filter criteria for `WorkPool.is_paused`
status:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterStatus'
- type: 'null'
description: Filter criteria for `WorkPool.status`
created_by:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterCreatedBy'
- type: 'null'
description: Filter criteria for `WorkPool.created_by`
updated_by:
anyOf:
- $ref: '#/components/schemas/WorkPoolFilterUpdatedBy'
- type: 'null'
description: Filter criteria for `WorkPool.updated_by`
additionalProperties: false
type: object
title: WorkPoolFilter
TaskRunFilterExpectedStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include task runs expected to start at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include task runs expected to start at or after this time
additionalProperties: false
type: object
title: TaskRunFilterExpectedStartTime
description: Filter by `TaskRun.expected_start_time`.
FlowRunFilterStateName:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of flow run state names to include
not_any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Not Any
description: A list of flow run state names to exclude
additionalProperties: false
type: object
title: FlowRunFilterStateName
FlowRunFilterCreatedBy:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
id_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Id
description: A list of creator IDs to include
type_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Type
description: A list of creator types to include. For example, 'DEPLOYMENT' for scheduled runs or 'AUTOMATION' for runs triggered by automations.
examples:
- - DEPLOYMENT
- AUTOMATION
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs w
# --- truncated at 32 KB (84 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-flows-api-openapi.yml