Prefect Artifacts 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 Artifacts. 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
9 operations
across 7 paths,
and defines 86 schemas.
It is described by OpenAPI 3.2.0, at version 0.8.4.
The identity and technical contract details declared by the specification.
FlowRunFilterTags
object
Filter by FlowRun.tags.
4 properties
ArtifactCollectionFilterType
object
Filter by ArtifactCollection.type.
2 properties
ArtifactFilterType
object
Filter by Artifact.type.
2 properties
Body_count_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_count_post
object
5 properties
FlowFilterCreatedBy
object
Filter by Flow.createdby.
4 properties
FlowRunFilterIdempotencyKey
object
Filter by FlowRun.idempotencykey.
2 properties
FlowRunFilterState
object
3 properties
FlowRunFilterEndTime
object
Filter by FlowRun.endtime.
3 properties
DeploymentOrFlowNameFilter
object
Filter by Deployment.name or Flow.name with a single input string for ilike filtering.
1 property
FlowRunFilterDeploymentVersionInfo
object
Filter by FlowRun.deploymentversioninfo.
3 properties
1 required
FlowRunFilterFlowId
object
Filter by FlowRun.flowid.
2 properties
Body_read_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_filter_post
object
8 properties
ArtifactSort
string
Defines artifact sorting options.
Body_count_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_count_post
object
5 properties
DeploymentFilterCreatedBy
object
Filter by Deployment.createdby.
4 properties
FlowRunFilterId
object
Filter by FlowRun.id.
2 properties
ArtifactFilterId
object
Filter by Artifact.id.
1 property
TaskRunFilterExpectedStartTime
object
Filter by TaskRun.expectedstarttime.
2 properties
FlowRunFilterStateName
object
2 properties
FlowRunFilterCreatedBy
object
Filter by FlowRun.createdby.
4 properties
TaskRunFilterEndTime
object
Filter by TaskRun.endtime.
3 properties
FlowRunFilterDeploymentId
object
Filter by FlowRun.deploymentid.
3 properties
ArtifactCollectionFilterLatestId
object
Filter by ArtifactCollection.latestid.
1 property
DeploymentStatus
string
Enumeration of deployment statuses.
FlowRunFilterWorkQueueId
object
Filter by FlowRun.workqueueid.
3 properties
FlowRunFilterDeploymentVersionId
object
Filter by FlowRun.deploymentversionid.
3 properties
1 required
FlowRunFilterWorkQueueName
object
Filter by FlowRun.workqueuename.
3 properties
FlowFilterTags
object
Filter by Flow.tags.
3 properties
DeploymentFilterWorkQueueId
object
Filter by Deployment.workqueueid
1 property
DeploymentFilterName
object
Filter by Deployment.name.
2 properties
TaskRunFilter
object
Filter task runs. Only task runs matching all criteria will be returned
10 properties
FlowFilterDeployment
object
Filter by flows by deployment
2 properties
TaskRunFilterName
object
Filter by TaskRun.name.
2 properties
ArtifactUpdate
object
Data used by the Prefect REST API to update an artifact.
3 properties
ArtifactFilterKey
object
Filter by Artifact.key.
3 properties
ArtifactCollectionFilterFlowRunId
object
Filter by ArtifactCollection.flowrunid.
1 property
FlowRunFilterNextScheduledStartTime
object
Filter by FlowRun.nextscheduledstarttime.
2 properties
TaskRunFilterTags
object
Filter by TaskRun.tags.
3 properties
TaskRunFilterStateType
object
Filter by TaskRun.statetype.
1 property
ArtifactFilterFlowRunId
object
Filter by Artifact.flowrunid.
1 property
DeploymentFilterConcurrencyLimit
object
DEPRECATED: Prefer Deployment.concurrencylimitid over Deployment.concurrencylimit.
3 properties
DeploymentFilter
object
Filter for deployments. Only deployments matching all criteria will be returned.
17 properties
TaskRunFilterStateName
object
1 property
DeploymentFilterBranch
object
Filter by Deployment.branch.
3 properties
ArtifactCollectionFilterKey
object
Filter by ArtifactCollection.key.
3 properties
ArtifactCollectionFilter
object
Filter artifact collections. Only artifact collections matching all criteria will be returned
6 properties
FlowRunFilterStateType
object
Filter by FlowRun.statetype.
2 properties
DeploymentFilterId
object
Filter by Deployment.id.
2 properties
TaskRunFilterId
object
Filter by TaskRun.id.
1 property
TaskRunFilterFlowRunId
object
Filter by TaskRun.flowrunid.
3 properties
ArtifactCollectionSort
string
Defines artifact collection sorting options.
DeploymentFilterFlowId
object
Filter by Deployment.flowid.
1 property
FlowRunFilterParentTaskRunId
object
Filter by FlowRun.parenttaskrunid.
3 properties
FlowRunFilterExpectedStartTime
object
Filter by FlowRun.expectedstarttime.
2 properties
FlowFilterId
object
Filter by Flow.id.
2 properties
FlowRunFilterStartTime
object
Filter by FlowRun.starttime.
3 properties
ArtifactCollectionFilterTaskRunId
object
Filter by ArtifactCollection.taskrunid.
1 property
FlowFilterName
object
Filter by Flow.name.
2 properties
TaskRunFilterSubFlowRuns
object
Filter by TaskRun.subflowrun.
1 property
DeploymentFilterUpdatedBy
object
Filter by Deployment.updatedby.
4 properties
DeploymentFilterTags
object
Filter by Deployment.tags.
4 properties
Artifact
object
10 properties
DeploymentFilterPaused
object
Filter by Deployment.paused.
1 property
FlowRunFilterName
object
Filter by FlowRun.name.
2 properties
StateType
string
Enumeration of state types.
Body_read_latest_artifacts_api_accounts__account_id__workspaces__workspace_id__artifacts_latest_filter_post
object
8 properties
FlowFilter
object
Filter for flows. Only flows matching all criteria will be returned.
7 properties
DeploymentFilterIsScheduleActive
object
Legacy filter to filter by Deployment.isscheduleactive which is always the opposite of Deployment.paused.
1 property
DeploymentFilterBase
object
Filter by Deployment.base.
2 properties
TaskRunFilterState
object
3 properties
FlowRunFilterParentFlowRunId
object
2 properties
FlowRunFilter
object
Filter flow runs. Only flow runs matching all criteria will be returned
20 properties
ArtifactFilter
object
Filter artifacts. Only artifacts matching all criteria will be returned
6 properties
ArtifactCollection
object
11 properties
2 required
TaskRunFilterStartTime
object
Filter by TaskRun.starttime.
3 properties
ArtifactCreate
object
Data used by the Prefect REST API to create an artifact.
7 properties
HTTPValidationError
object
1 property
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.
DeploymentFilterRoot
object
Filter by Deployment.root.
2 properties
FlowFilterUpdatedBy
object
Filter by Flow.updatedby.
4 properties
DeploymentFilterStatus
object
Filter by Deployment.status.
1 property
ArtifactFilterTaskRunId
object
Filter by Artifact.taskrunid.
1 property
ValidationError
object
3 properties
3 required
DeploymentFilterWorkQueueName
object
Filter by Deployment.workqueuename.
1 property
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Prefect publishes across the network.