Read Latest Artifacts

Retrieve artifacts from the database.

Headers

x-prefect-api-version

string

Body

application/json

sort

enum<string>

Defines artifact collection 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 artifact collections. Only artifact collections matching all criteria will be returned

Show child attributes

artifacts.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

artifacts.latest_id

object | null

Filter criteria for Artifact.id

Show child attributes

artifacts.latest_id.any_

string[] | null

A list of artifact ids to include

artifacts.key

object | null

Filter criteria for Artifact.key

Show child attributes

artifacts.key.any_

string[] | null

A list of artifact keys to include

artifacts.key.like_

string | null

A string to match artifact keys against. This can include SQL wildcard characters like % and _.

artifacts.key.exists_

boolean | null

If true, only include artifacts with a non-null key. If false, only include artifacts with a null key. Should return all rows in the ArtifactCollection table if specified.

artifacts.flow_run_id

object | null

Filter criteria for Artifact.flow_run_id

Show child attributes

artifacts.flow_run_id.any_

string[] | null

A list of flow run IDs to include

artifacts.task_run_id

object | null

Filter criteria for Artifact.task_run_id

Show child attributes

artifacts.task_run_id.any_

string[] | null

A list of task run IDs to include

artifacts.type

object | null

Filter criteria for Artifact.type

Show child attributes

artifacts.type.any_

string[] | null

A list of artifact types to include

artifacts.type.not_any_

string[] | null

A list of artifact types to exclude

flow_runs

object

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

Show child attributes

flow_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.id

object | null

Filter criteria for FlowRun.id

Show child attributes

flow_runs.id.any_

string[] | null

A list of flow run ids to include

flow_runs.id.not_any_

string[] | null

A list of flow run ids to exclude

flow_runs.name

object | null

Filter criteria for FlowRun.name

Show child attributes

flow_runs.name.any_

string[] | null

A list of flow run names to include

flow_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

flow_runs.tags

object | null

Filter criteria for FlowRun.tags

Show child attributes

flow_runs.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.tags.all_

string[] | null

A list of tags. Flow runs will be returned only if their tags are a superset of the list

flow_runs.tags.any_

string[] | null

A list of tags to include

flow_runs.tags.is_null_

boolean | null

If true, only include flow runs without tags

flow_runs.deployment_id

object | null

Filter criteria for FlowRun.deployment_id

Show child attributes

flow_runs.deployment_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.deployment_id.any_

string[] | null

A list of flow run deployment ids to include

flow_runs.deployment_id.is_null_

boolean | null

If true, only include flow runs without deployment ids

flow_runs.work_queue_name

object | null

Filter criteria for `FlowRun.work_queue_name

Show child attributes

flow_runs.work_queue_name.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.work_queue_name.any_

string[] | null

A list of work queue names to include

flow_runs.work_queue_name.is_null_

boolean | null

If true, only include flow runs without work queue names

flow_runs.state

object | null

Filter criteria for FlowRun.state

Show child attributes

flow_runs.state.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.state.type

object | null

Filter criteria for FlowRun.state_type

Show child attributes

flow_runs.state.type.any_

enum<string>[] | null

A list of flow run state types to include

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.state.type.not_any_

enum<string>[] | null

A list of flow run state types to exclude

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

flow_runs.state.name

object | null

Filter criteria for FlowRun.state_name

Show child attributes

flow_runs.state.name.any_

string[] | null

A list of flow run state names to include

flow_runs.state.name.not_any_

string[] | null

A list of flow run state names to exclude

flow_runs.flow_version

object | null

Filter criteria for FlowRun.flow_version

Show child attributes

flow_runs.flow_version.any_

string[] | null

A list of flow run flow_versions to include

flow_runs.start_time

object | null

Filter criteria for FlowRun.start_time

Show child attributes

flow_runs.start_time.before_

string | null

Only include flow runs starting at or before this time

flow_runs.start_time.after_

string | null

Only include flow runs starting at or after this time

flow_runs.start_time.is_null_

boolean | null

If true, only return flow runs without a start time

flow_runs.end_time

object | null

Filter criteria for FlowRun.end_time

Show child attributes

flow_runs.end_time.before_

string | null

Only include flow runs ending at or before this time

flow_runs.end_time.after_

string | null

Only include flow runs ending at or after this time

flow_runs.end_time.is_null_

boolean | null

If true, only return flow runs without an end time

flow_runs.expected_start_time

object | null

Filter criteria for FlowRun.expected_start_time

Show child attributes

flow_runs.expected_start_time.before_

string | null

Only include flow runs scheduled to start at or before this time

flow_runs.expected_start_time.after_

string | null

Only include flow runs scheduled to start at or after this time

flow_runs.next_scheduled_start_time

object | null

Filter criteria for FlowRun.next_scheduled_start_time

Show child attributes

flow_runs.next_scheduled_start_time.before_

string | null

Only include flow runs with a next_scheduled_start_time or before this time

flow_runs.next_scheduled_start_time.after_

string | null

Only include flow runs with a next_scheduled_start_time at or after this time

flow_runs.parent_flow_run_id

object | null

Filter criteria for subflows of the given flow runs

Show child attributes

flow_runs.parent_flow_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_flow_run_id.any_

string[] | null

A list of parent flow run ids to include

flow_runs.parent_task_run_id

object | null

Filter criteria for FlowRun.parent_task_run_id

Show child attributes

flow_runs.parent_task_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flow_runs.parent_task_run_id.any_

string[] | null

A list of flow run parent_task_run_ids to include

flow_runs.parent_task_run_id.is_null_

boolean | null

If true, only include flow runs without parent_task_run_id

flow_runs.idempotency_key

object | null

Filter criteria for FlowRun.idempotency_key

Show child attributes

flow_runs.idempotency_key.any_

string[] | null

A list of flow run idempotency keys to include

flow_runs.idempotency_key.not_any_

string[] | null

A list of flow run idempotency keys to exclude

task_runs

object

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

Show child attributes

task_runs.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.id

object | null

Filter criteria for TaskRun.id

Show child attributes

task_runs.id.any_

string[] | null

A list of task run ids to include

task_runs.name

object | null

Filter criteria for TaskRun.name

Show child attributes

task_runs.name.any_

string[] | null

A list of task run names to include

task_runs.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

task_runs.tags

object | null

Filter criteria for TaskRun.tags

Show child attributes

task_runs.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.tags.all_

string[] | null

A list of tags. Task runs will be returned only if their tags are a superset of the list

task_runs.tags.is_null_

boolean | null

If true, only include task runs without tags

task_runs.state

object | null

Filter criteria for TaskRun.state

Show child attributes

task_runs.state.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.state.type

object | null

Filter criteria for TaskRun.state_type

Show child attributes

task_runs.state.type.any_

enum<string>[] | null

A list of task run state types to include

Available options:

SCHEDULED,

PENDING,

RUNNING,

COMPLETED,

FAILED,

CANCELLED,

CRASHED,

PAUSED,

CANCELLING

task_runs.state.name

object | null

Filter criteria for TaskRun.state_name

Show child attributes

task_runs.state.name.any_

string[] | null

A list of task run state names to include

task_runs.start_time

object | null

Filter criteria for TaskRun.start_time

Show child attributes

task_runs.start_time.before_

string | null

Only include task runs starting at or before this time

task_runs.start_time.after_

string | null

Only include task runs starting at or after this time

task_runs.start_time.is_null_

boolean | null

If true, only return task runs without a start time

task_runs.expected_start_time

object | null

Filter criteria for TaskRun.expected_start_time

Show child attributes

task_runs.expected_start_time.before_

string | null

Only include task runs expected to start at or before this time

task_runs.expected_start_time.after_

string | null

Only include task runs expected to start at or after this time

task_runs.subflow_runs

object | null

Filter criteria for TaskRun.subflow_run

Show child attributes

task_runs.subflow_runs.exists_

boolean | null

If true, only include task runs that are subflow run parents; if false, exclude parent task runs

task_runs.flow_run_id

object | null

Filter criteria for TaskRun.flow_run_id

Show child attributes

task_runs.flow_run_id.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

task_runs.flow_run_id.any_

string[] | null

A list of task run flow run ids to include

task_runs.flow_run_id.is_null_

boolean | null

default: false

Filter for task runs with None as their flow run id

flows

object

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

Show child attributes

flows.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.id

object | null

Filter criteria for Flow.id

Show child attributes

flows.id.any_

string[] | null

A list of flow ids to include

flows.deployment

object | null

Filter criteria for Flow deployments

Show child attributes

flows.deployment.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.deployment.is_null_

boolean | null

If true, only include flows without deployments

flows.name

object | null

Filter criteria for Flow.name

Show child attributes

flows.name.any_

string[] | null

A list of flow names to include

flows.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

flows.tags

object | null

Filter criteria for Flow.tags

Show child attributes

flows.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

flows.tags.all_

string[] | null

A list of tags. Flows will be returned only if their tags are a superset of the list

flows.tags.is_null_

boolean | null

If true, only include flows without tags

deployments

object

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

Show child attributes

deployments.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.id

object | null

Filter criteria for Deployment.id

Show child attributes

deployments.id.any_

string[] | null

A list of deployment ids to include

deployments.name

object | null

Filter criteria for Deployment.name

Show child attributes

deployments.name.any_

string[] | null

A list of deployment names to include

deployments.name.like_

string | null

A case-insensitive partial match. For example, passing 'marvin' will match 'marvin', 'sad-Marvin', and 'marvin-robot'.

deployments.flow_or_deployment_name

object | null

Filter criteria for Deployment.name or Flow.name

Show child attributes

deployments.flow_or_deployment_name.like_

string | null

A case-insensitive partial match on deployment or flow names. For example, passing 'example' might match deployments or flows with 'example' in their names.

deployments.paused

object | null

Filter criteria for Deployment.paused

Show child attributes

deployments.paused.eq_

boolean | null

Only returns where deployment is/is not paused

deployments.tags

object | null

Filter criteria for Deployment.tags

Show child attributes

deployments.tags.operator

enum<string>

Operator for combining filter criteria. Defaults to 'and_'.

Available options:

and_,

or_

deployments.tags.all_

string[] | null

A list of tags. Deployments will be returned only if their tags are a superset of the list

deployments.tags.is_null_

boolean | null

If true, only include deployments without tags

deployments.work_queue_name

object | null

Filter criteria for Deployment.work_queue_name

Show child attributes

deployments.work_queue_name.any_

string[] | null

A list of work queue names to include

deployments.concurrency_limit

object | null

deprecated

DEPRECATED: Prefer Deployment.concurrency_limit_id over Deployment.concurrency_limit. If provided, will be ignored for backwards-compatibility. Will be removed after December 2024.

Show child attributes

deployments.concurrency_limit.ge_

integer | null

Only include deployments with a concurrency limit greater than or equal to this value

deployments.concurrency_limit.le_

integer | null

Only include deployments with a concurrency limit less than or equal to this value

deployments.concurrency_limit.is_null_

boolean | null

If true, only include deployments without a concurrency limit

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

required

An optional unique reference key for this artifact.

latest_id

string

required

The latest artifact ID associated with the key.

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.

Show child attributes

metadata_.{key}

string

flow_run_id

string | null

The flow run associated with the artifact.

task_run_id

string | null

The task run associated with the artifact.