Prefect Artifacts API
The Artifacts API from Prefect — 7 operation(s) for artifacts.
The Artifacts API from Prefect — 7 operation(s) for artifacts.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/prefect-artifacts-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: Prefect Cloud Account Billing Artifacts API
description: Prefect Cloud REST API documentation.
version: 0.8.4
tags:
- name: Artifacts
paths:
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/:
post:
tags:
- Artifacts
summary: Create Artifact
description: '
Required workspace scopes: `write_artifacts`'
operationId: create_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__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/ArtifactCreate'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Artifact'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/{id}:
get:
tags:
- Artifacts
summary: Read Artifact
description: 'Retrieve an artifact from the database.
Required workspace scopes: `see_artifacts`'
operationId: read_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__get
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The ID of the artifact to retrieve.
title: Id
description: The ID of the artifact to retrieve.
- 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
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Artifact'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
patch:
tags:
- Artifacts
summary: Update Artifact
description: 'Update an artifact in the database.
Required workspace scopes: `write_artifacts`'
operationId: update_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__patch
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The ID of the artifact to update.
title: Id
description: The ID of the artifact to update.
- 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/ArtifactUpdate'
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
delete:
tags:
- Artifacts
summary: Delete Artifact
description: 'Delete an artifact from the database.
Required workspace scopes: `manage_artifacts`'
operationId: delete_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__id__delete
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: The ID of the artifact to delete.
title: Id
description: The ID of the artifact to delete.
- 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
responses:
'204':
description: Successful Response
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/{key}/latest:
get:
tags:
- Artifacts
summary: Read Latest Artifact
description: 'Retrieve the latest artifact from the database.
Required workspace scopes: `see_artifacts`'
operationId: read_latest_artifact_api_accounts__account_id__workspaces__workspace_id__artifacts__key__latest_get
parameters:
- name: key
in: path
required: true
schema:
type: string
description: The key of the artifact to retrieve.
title: Key
description: The key of the artifact to retrieve.
- 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
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/Artifact'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/filter:
post:
tags:
- Artifacts
summary: Read Artifacts
description: 'Retrieve artifacts from the database.
Required workspace scopes: `see_artifacts`'
operationId: read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_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_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Artifact'
title: Response Read Artifacts Api Accounts Account Id Workspaces Workspace Id Artifacts Filter Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/latest/filter:
post:
tags:
- Artifacts
summary: Read Latest Artifacts
description: 'Retrieve artifacts from the database.
Required workspace scopes: `see_artifacts`'
operationId: read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_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_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ArtifactCollection'
title: Response Read Latest Artifacts Api Accounts Account Id Workspaces Workspace Id Artifacts Latest Filter Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/count:
post:
tags:
- Artifacts
summary: Count Artifacts
description: 'Count artifacts in the database.
Required workspace scopes: `see_artifacts`'
operationId: count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_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_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Count Artifacts Api Accounts Account Id Workspaces Workspace Id Artifacts Count Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/accounts/{account_id}/workspaces/{workspace_id}/artifacts/latest/count:
post:
tags:
- Artifacts
summary: Count Latest Artifacts
description: 'Count artifacts from the database.
Required workspace scopes: `see_artifacts`'
operationId: count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_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_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
type: integer
title: Response Count Latest Artifacts Api Accounts Account Id Workspaces Workspace Id Artifacts Latest Count Post
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
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`.
ArtifactCollectionFilterType:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of artifact types to include
not_any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Not Any
description: A list of artifact types to exclude
additionalProperties: false
type: object
title: ArtifactCollectionFilterType
description: Filter by `ArtifactCollection.type`.
ArtifactFilterType:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of artifact types to include
not_any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Not Any
description: A list of artifact types to exclude
additionalProperties: false
type: object
title: ArtifactFilterType
description: Filter by `Artifact.type`.
Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post:
properties:
artifacts:
anyOf:
- $ref: '#/components/schemas/ArtifactFilter'
- type: 'null'
flow_runs:
anyOf:
- $ref: '#/components/schemas/FlowRunFilter'
- type: 'null'
task_runs:
anyOf:
- $ref: '#/components/schemas/TaskRunFilter'
- type: 'null'
flows:
anyOf:
- $ref: '#/components/schemas/FlowFilter'
- type: 'null'
deployments:
anyOf:
- $ref: '#/components/schemas/DeploymentFilter'
- type: 'null'
type: object
title: Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_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`.
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
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`.
Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post:
properties:
sort:
$ref: '#/components/schemas/ArtifactSort'
default: ID_DESC
offset:
type: integer
minimum: 0.0
title: Offset
default: 0
artifacts:
anyOf:
- $ref: '#/components/schemas/ArtifactFilter'
- type: 'null'
flow_runs:
anyOf:
- $ref: '#/components/schemas/FlowRunFilter'
- type: 'null'
task_runs:
anyOf:
- $ref: '#/components/schemas/TaskRunFilter'
- type: 'null'
flows:
anyOf:
- $ref: '#/components/schemas/FlowFilter'
- type: 'null'
deployments:
anyOf:
- $ref: '#/components/schemas/DeploymentFilter'
- type: 'null'
limit:
type: integer
title: Limit
description: Defaults to PREFECT_ORION_API_DEFAULT_LIMIT if not provided.
type: object
title: Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post
ArtifactSort:
type: string
enum:
- CREATED_DESC
- UPDATED_DESC
- ID_DESC
- KEY_DESC
- KEY_ASC
title: ArtifactSort
description: Defines artifact sorting options.
Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post:
properties:
artifacts:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilter'
- type: 'null'
flow_runs:
anyOf:
- $ref: '#/components/schemas/FlowRunFilter'
- type: 'null'
task_runs:
anyOf:
- $ref: '#/components/schemas/TaskRunFilter'
- type: 'null'
flows:
anyOf:
- $ref: '#/components/schemas/FlowFilter'
- type: 'null'
deployments:
anyOf:
- $ref: '#/components/schemas/DeploymentFilter'
- type: 'null'
type: object
title: Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post
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.
ArtifactFilterId:
properties:
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of artifact ids to include
additionalProperties: false
type: object
title: ArtifactFilterId
description: Filter by `Artifact.id`.
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 without a creator
additionalProperties: false
type: object
title: FlowRunFilterCreatedBy
description: Filter by `FlowRun.created_by`.
TaskRunFilterEndTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include task runs ending at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include task runs ending at or after this time
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only return task runs without an end time
additionalProperties: false
type: object
title: TaskRunFilterEndTime
description: Filter by `TaskRun.end_time`.
FlowRunFilterDeploymentId:
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 deployment ids to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without deployment ids
additionalProperties: false
type: object
title: FlowRunFilterDeploymentId
description: Filter by `FlowRun.deployment_id`.
ArtifactCollectionFilterLatestId:
properties:
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of artifact ids to include
additionalProperties: false
type: object
title: ArtifactCollectionFilterLatestId
description: Filter by `ArtifactCollection.latest_id`.
DeploymentStatus:
type: string
enum:
- READY
- NOT_READY
- DISABLED
title: DeploymentStatus
description: Enumeration of deployment statuses.
FlowRunFilterWorkQueueId:
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 work queue ids to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without work queue ids
additionalProperties: false
type: object
title: FlowRunFilterWorkQueueId
description: Filter by `FlowRun.work_queue_id`.
FlowRunFilterDeploymentVersionId:
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:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of flow run
# --- truncated at 32 KB (83 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/prefect/refs/heads/main/openapi/prefect-artifacts-api-openapi.yml