Prefect Artifacts API
The Artifacts API from Prefect — 7 operation(s) for artifacts.
OpenAPI Specification
openapi: 3.1.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:
FlowRunFilterNextScheduledStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include flow runs with a next_scheduled_start_time or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include flow runs with a next_scheduled_start_time at or after this time
additionalProperties: false
type: object
title: FlowRunFilterNextScheduledStartTime
description: Filter by `FlowRun.next_scheduled_start_time`.
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`.
FlowRunFilterParentTaskRunId:
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 parent_task_run_ids to include
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include flow runs without parent_task_run_id
additionalProperties: false
type: object
title: FlowRunFilterParentTaskRunId
description: Filter by `FlowRun.parent_task_run_id`.
DeploymentFilterName:
properties:
any_:
anyOf:
- items:
type: string
type: array
- type: 'null'
title: Any
description: A list of deployment names to include
examples:
- - my-deployment-1
- my-deployment-2
like_:
anyOf:
- type: string
- type: 'null'
title: Like
description: A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.
examples:
- marvin
additionalProperties: false
type: object
title: DeploymentFilterName
description: Filter by `Deployment.name`.
DeploymentFilter:
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/DeploymentFilterId'
- type: 'null'
description: Filter criteria for `Deployment.id`
branch:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterBranch'
- type: 'null'
description: Filter criteria for `Deployment.branch`
base:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterBase'
- type: 'null'
description: Filter criteria for `Deployment.base`
root:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterRoot'
- type: 'null'
description: Filter criteria for `Deployment.root`
name:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterName'
- type: 'null'
description: Filter criteria for `Deployment.name`
is_schedule_active:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterIsScheduleActive'
- type: 'null'
description: Filter criteria for `Deployment.is_schedule_active`
paused:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterPaused'
- type: 'null'
description: Filter criteria for `Deployment.paused`
tags:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterTags'
- type: 'null'
description: Filter criteria for `Deployment.tags`
work_queue_name:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterWorkQueueName'
- type: 'null'
description: Filter criteria for `Deployment.work_queue_name`
concurrency_limit:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterConcurrencyLimit'
- type: 'null'
description: 'DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.'
deprecated: true
work_queue_id:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterWorkQueueId'
- type: 'null'
description: Filter criteria for `Deployment.work_queue_id`
status:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterStatus'
- type: 'null'
description: Filter criteria for `Deployment.status`
flow_or_deployment_name:
anyOf:
- $ref: '#/components/schemas/DeploymentOrFlowNameFilter'
- type: 'null'
description: Filter criteria for `Deployment.name` or `Flow.name`
flow_id:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterFlowId'
- type: 'null'
description: Filter criteria for `Deployment.flow_id`
created_by:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterCreatedBy'
- type: 'null'
description: Filter criteria for `Deployment.created_by`
updated_by:
anyOf:
- $ref: '#/components/schemas/DeploymentFilterUpdatedBy'
- type: 'null'
description: Filter criteria for `Deployment.updated_by`
additionalProperties: false
type: object
title: DeploymentFilter
description: Filter for deployments. Only deployments matching all criteria will be returned.
DeploymentFilterBase:
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
type: array
- type: 'null'
title: Any
description: A list of deployments that have a base to include
examples:
- - deployment1
- deployment2
additionalProperties: false
type: object
title: DeploymentFilterBase
description: Filter by `Deployment.base`.
ArtifactCollectionFilter:
properties:
operator:
$ref: '#/components/schemas/prefect_cloud__orion__schemas__filters__Operator'
description: Operator for combining filter criteria. Defaults to 'and_'.
default: and_
latest_id:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilterLatestId'
- type: 'null'
description: Filter criteria for `Artifact.id`
key:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilterKey'
- type: 'null'
description: Filter criteria for `Artifact.key`
flow_run_id:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilterFlowRunId'
- type: 'null'
description: Filter criteria for `Artifact.flow_run_id`
task_run_id:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilterTaskRunId'
- type: 'null'
description: Filter criteria for `Artifact.task_run_id`
type:
anyOf:
- $ref: '#/components/schemas/ArtifactCollectionFilterType'
- type: 'null'
description: Filter criteria for `Artifact.type`
additionalProperties: false
type: object
title: ArtifactCollectionFilter
description: Filter artifact collections. Only artifact collections matching all criteria will be returned
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
TaskRunFilterStartTime:
properties:
before_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Before
description: Only include task runs starting at or before this time
after_:
anyOf:
- type: string
format: date-time
- type: 'null'
title: After
description: Only include task runs starting at or after this time
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only return task runs without a start time
additionalProperties: false
type: object
title: TaskRunFilterStartTime
description: Filter by `TaskRun.start_time`.
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`.
DeploymentFilterConcurrencyLimit:
properties:
ge_:
anyOf:
- type: integer
- type: 'null'
title: Ge
description: Only include deployments with a concurrency limit greater than or equal to this value
le_:
anyOf:
- type: integer
- type: 'null'
title: Le
description: Only include deployments with a concurrency limit less than or equal to this value
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include deployments without a concurrency limit
additionalProperties: false
type: object
title: DeploymentFilterConcurrencyLimit
description: 'DEPRECATED: Prefer `Deployment.concurrency_limit_id` over `Deployment.concurrency_limit`.'
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`.
FlowRunFilterStateType:
properties:
any_:
anyOf:
- items:
$ref: '#/components/schemas/StateType'
type: array
- type: 'null'
title: Any
description: A list of flow run state types to include
not_any_:
anyOf:
- items:
$ref: '#/components/schemas/StateType'
type: array
- type: 'null'
title: Not Any
description: A list of flow run state types to exclude
additionalProperties: false
type: object
title: FlowRunFilterStateType
description: Filter by `FlowRun.state_type`.
TaskRunFilterSubFlowRuns:
properties:
exists_:
anyOf:
- type: boolean
- type: 'null'
title: Exists
description: If true, only include task runs that are subflow run parents; if false, exclude parent task runs
additionalProperties: false
type: object
title: TaskRunFilterSubFlowRuns
description: Filter by `TaskRun.subflow_run`.
DeploymentFilterPaused:
properties:
eq_:
anyOf:
- type: boolean
- type: 'null'
title: Eq
description: Only returns where deployment is/is not paused
additionalProperties: false
type: object
title: DeploymentFilterPaused
description: Filter by `Deployment.paused`.
DeploymentFilterBranch:
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
type: array
- type: 'null'
title: Any
description: A list of branches to include
examples:
- - tag-1
- tag-2
is_null_:
anyOf:
- type: boolean
- type: 'null'
title: Is Null
description: If true, only include root deployments, those without branches
additionalProperties: false
type: object
title: DeploymentFilterBranch
description: Filter by `Deployment.branch`.
DeploymentFilterFlowId:
properties:
any_:
anyOf:
- items:
type: string
format: uuid
type: array
- type: 'null'
title: Any
description: A list of flow ids to include
additionalProperties: false
type: object
title: DeploymentFilterFlowId
description: Filter by `Deployment.flow_id`.
TaskRunFilterState:
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/TaskRunFilterStateType'
- type: 'null'
description: Filter criteria for `TaskRun.state_type`
name:
anyOf:
- $ref: '#/components/schemas/TaskRunFilterStateName'
- type: 'null'
description: Filter criteria for `TaskRun.state_name`
additionalProperties: false
type: object
title: TaskRunFilterState
prefect_cloud__orion__schemas__filters__Operator:
type: string
enum:
- and_
- or_
title: Operator
description: Operators for combining filter criteria.
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`.
Artifact:
properties:
id:
type: string
format: uuid
title: Id
created:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Created
updated:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Updated
key:
anyOf:
- type: string
- type: 'null'
title: Key
description: An optional unique reference key for this artifact.
type:
anyOf:
- type: string
- type: 'null'
title: Type
description: An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'
description:
anyOf:
- type: string
- type: 'null'
title: Description
description: A markdown-enabled description of the artifact.
data:
anyOf:
- additionalProperties: true
type: object
- {}
- type: 'null'
title: Data
description: Data associated with the artifact, e.g. a result.; structure depends on the artifact type.Content must be storable as JSON.
metadata_:
anyOf:
- additionalProperties:
type: string
type: object
- type: 'null'
# --- 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