Create Artifact

curl --request POST \
  --url https://api.example.com/artifacts/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "type": "<string>",
  "description": "<string>",
  "data": {},
  "metadata_": {},
  "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/artifacts/"

payload = {
    "key": "<string>",
    "type": "<string>",
    "description": "<string>",
    "data": {},
    "metadata_": {},
    "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    type: '<string>',
    description: '<string>',
    data: {},
    metadata_: {},
    flow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    task_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/artifacts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/artifacts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'data' => [
        
    ],
    'metadata_' => [
        
    ],
    'flow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'task_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/artifacts/"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/artifacts/")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/artifacts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "type": "<string>",
  "description": "<string>",
  "data": {},
  "metadata_": {},
  "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

POST

artifacts

Create Artifact

curl --request POST \
  --url https://api.example.com/artifacts/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "key": "<string>",
  "type": "<string>",
  "description": "<string>",
  "data": {},
  "metadata_": {},
  "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.example.com/artifacts/"

payload = {
    "key": "<string>",
    "type": "<string>",
    "description": "<string>",
    "data": {},
    "metadata_": {},
    "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    key: '<string>',
    type: '<string>',
    description: '<string>',
    data: {},
    metadata_: {},
    flow_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    task_run_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.example.com/artifacts/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/artifacts/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'key' => '<string>',
    'type' => '<string>',
    'description' => '<string>',
    'data' => [
        
    ],
    'metadata_' => [
        
    ],
    'flow_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'task_run_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/artifacts/"

	payload := strings.NewReader("{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/artifacts/")
  .header("Content-Type", "application/json")
  .body("{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/artifacts/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"key\": \"<string>\",\n  \"type\": \"<string>\",\n  \"description\": \"<string>\",\n  \"data\": {},\n  \"metadata_\": {},\n  \"flow_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"task_run_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created": "2023-11-07T05:31:56Z",
  "updated": "2023-11-07T05:31:56Z",
  "key": "<string>",
  "type": "<string>",
  "description": "<string>",
  "data": {},
  "metadata_": {},
  "flow_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "task_run_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

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.

Show child attributes

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

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.

Show child attributes

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.