Documentation Index Fetch the complete documentation index at: https://docs.prefect.io/llms.txt
Use this file to discover all available pages before exploring further.
prefect.server.api.artifactsRoutes for interacting with artifact objects.
Functions create_artifact create_artifact(artifact: actions.ArtifactCreate, response: Response, db: PrefectDBInterface = Depends(provide_database_interface)) -> core.Artifact
Create an artifact.
For more information, see https://docs.prefect.io/v3/concepts/artifacts .
read_artifact read_artifact(artifact_id: UUID = Path( ... , description = 'The ID of the artifact to retrieve.' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> core.Artifact
Retrieve an artifact from the database.
read_latest_artifact read_latest_artifact(key: str = Path( ... , description = 'The key of the artifact to retrieve.' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> core.Artifact
Retrieve the latest artifact from the artifact table.
read_artifacts read_artifacts(sort: sorting.ArtifactSort = Body(sorting.ArtifactSort. ID_DESC ), limit: int = dependencies.LimitBody(), offset: int = Body( 0 , ge = 0 ), artifacts: filters.ArtifactFilter = None , flow_runs: filters.FlowRunFilter = None , task_runs: filters.TaskRunFilter = None , flows: filters.FlowFilter = None , deployments: filters.DeploymentFilter = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> List[core.Artifact]
Retrieve artifacts from the database.
read_latest_artifacts read_latest_artifacts(sort: sorting.ArtifactCollectionSort = Body(sorting.ArtifactCollectionSort. ID_DESC ), limit: int = dependencies.LimitBody(), offset: int = Body( 0 , ge = 0 ), artifacts: filters.ArtifactCollectionFilter = None , flow_runs: filters.FlowRunFilter = None , task_runs: filters.TaskRunFilter = None , flows: filters.FlowFilter = None , deployments: filters.DeploymentFilter = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> List[core.ArtifactCollection]
Retrieve artifacts from the database.
count_artifacts count_artifacts(artifacts: filters.ArtifactFilter = None , flow_runs: filters.FlowRunFilter = None , task_runs: filters.TaskRunFilter = None , flows: filters.FlowFilter = None , deployments: filters.DeploymentFilter = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> int
Count artifacts from the database.
count_latest_artifacts count_latest_artifacts(artifacts: filters.ArtifactCollectionFilter = None , flow_runs: filters.FlowRunFilter = None , task_runs: filters.TaskRunFilter = None , flows: filters.FlowFilter = None , deployments: filters.DeploymentFilter = None , db: PrefectDBInterface = Depends(provide_database_interface)) -> int
Count artifacts from the database.
update_artifact update_artifact(artifact: actions.ArtifactUpdate, artifact_id: UUID = Path( ... , description = 'The ID of the artifact to update.' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Update an artifact in the database.
delete_artifact delete_artifact(artifact_id: UUID = Path( ... , description = 'The ID of the artifact to delete.' , alias = 'id' ), db: PrefectDBInterface = Depends(provide_database_interface)) -> None
Delete an artifact from the database. 
