Skip to main content
POST
Create Artifact

Headers

x-prefect-api-version
string

Body

application/json

Data used by the Prefect REST API to create an artifact.

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_
Metadata · object | null

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

flow_run_id
string<uuid> | null

The flow run associated with the artifact.

task_run_id
string<uuid> | null

The task run associated with the artifact.

Response

Successful Response

id
string<uuid>
created
string<date-time> | null
updated
string<date-time> | 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_
Metadata · object | null

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

flow_run_id
string<uuid> | null

The flow run associated with the artifact.

task_run_id
string<uuid> | null

The task run associated with the artifact.