POST
/
api
/
artifacts
/
filter

Headers

x-prefect-api-version
string

Body

application/json
sort
enum<string>

Defines artifact sorting options.

Available options:
CREATED_DESC,
UPDATED_DESC,
ID_DESC,
KEY_DESC,
KEY_ASC
offset
integer
default: 0
Required range: x > 0
artifacts
object

Filter artifacts. Only artifacts matching all criteria will be returned

flow_runs
object

Filter flow runs. Only flow runs matching all criteria will be returned

task_runs
object

Filter task runs. Only task runs matching all criteria will be returned

flows
object

Filter for flows. Only flows matching all criteria will be returned.

deployments
object

Filter for deployments. Only deployments matching all criteria will be returned.

limit
integer

Defaults to PREFECT_API_DEFAULT_LIMIT if not provided.

Response

200 - application/json
id
string
created
string | null
updated
string | null
key
string | null

An optional unique reference key for this artifact.

type
string | null

An identifier that describes the shape of the data field. e.g. 'result', 'table', 'markdown'

description
string | null

A markdown-enabled description of the artifact.

data

Data associated with the artifact, e.g. a result.; structure depends on the artifact type.

metadata_
object | null

User-defined artifact metadata. Content must be string key and value pairs.

flow_run_id
string | null

The flow run associated with the artifact.

task_run_id
string | null

The task run associated with the artifact.