Get Artifact Results

GET

api

artifact

{internal_artifact_id}

cURL

curl --request GET \
  --url https://eu.whitecircle.com/api/artifact/{internal_artifact_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: <whitecircle-version>'

import requests

url = "https://eu.whitecircle.com/api/artifact/{internal_artifact_id}"

headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://eu.whitecircle.com/api/artifact/{internal_artifact_id}', 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://eu.whitecircle.com/api/artifact/{internal_artifact_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.whitecircle.com/api/artifact/{internal_artifact_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu.whitecircle.com/api/artifact/{internal_artifact_id}")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/artifact/{internal_artifact_id}")

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

request = Net::HTTP::Get.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "policies": {},
  "kind": "<string>",
  "status": "<string>",
  "internal_artifact_id": "<string>",
  "flagged": true,
  "updated_at": "<string>",
  "external_artifact_id": "<string>",
  "external_session_id": "<string>",
  "internal_session_id": "<string>",
  "created_at": "<string>",
  "note": "<string>"
}

Retrieve the results of a previously submitted artifact check. You can look up an artifact either by its internal ID path or by your external ID query.

Route Shapes

Use one of these routes:

Route	Use when
`GET /api/artifact/{internal_artifact_id}`	You have the system-generated Artifact ID from a previous response
`GET /api/artifact?external_artifact_id=...`	You want the latest Artifact version for your external ID

environment_id remains optional on both routes. If you omit it, White Circle uses the Environment associated with your API key. The legacy deployment_id parameter is deprecated but still accepted as a predecessor of environment_id.

For exact immutable lookups, prefer internal_artifact_id over external_artifact_id.

When multiple Artifacts share the same external_artifact_id, White Circle returns the latest artifact version within the same Environment.

Example Requests

Using the internal Artifact ID:

curl -X GET "https://eu.whitecircle.com/api/artifact/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2026-06-01"

Using your external Artifact ID:

curl -X GET "https://eu.whitecircle.com/api/artifact?external_artifact_id=user-avatar-42" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2026-06-01"

Response Overview

Field	Type	Description
`flagged`	boolean \| null	`true` if any Policy was violated. `null` while processing or on failure.
`status`	string	Check status: `"completed"`, `"processing"`, or `"failed"`
`policies`	object	Map of Policy IDs to their violation statuses
`kind`	string	Content type of the Artifact (e.g., `"image"`)
`internal_artifact_id`	string	System-generated UUID for this Artifact
`external_artifact_id`	string	Your custom Artifact tracking ID (if provided)
`external_session_id`	string	External ID of the linked session (if attached)
`internal_session_id`	string	System-generated UUID of the linked session (if attached)
`updated_at`	string	ISO 8601 last update timestamp
`created_at`	string	ISO 8601 creation timestamp
`note`	string	Informational message, included when applicable (e.g. why an image fetch failed)

Each Policy in the policies object includes:

flagged — Whether this specific Policy was violated
name — Human-readable Policy name
enabled_by_conditions — The Conditions that selected this Policy, which is why it was evaluated. Absent when no Condition was involved.

Authorizations

Authorization

string

header

required

API Key required. Format: Bearer wc-your-api-key

Headers

whitecircle-version

string

required

API Version

Path Parameters

internal_artifact_id

string

required

Find an artifact by its internal artifact ID

Query Parameters

deployment_id

string

Optional deployment ID to validate artifact ownership

Response

Success

policies

object

required

Hide child attributes

policies.{key}

object

Hide child attributes

policies.{key}.flagged

boolean

required

policies.{key}.flagged_source

string[]

required

policies.{key}.name

string

required

kind

string

required

status

string

required

internal_artifact_id

string

required

flagged

boolean | null

updated_at

string | null

external_artifact_id

string | null

external_session_id

string | null

internal_session_id

string | null

created_at

string | null

note

string | null

⌘I

cURL

curl --request GET \
  --url https://eu.whitecircle.com/api/artifact/{internal_artifact_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'whitecircle-version: <whitecircle-version>'

import requests

url = "https://eu.whitecircle.com/api/artifact/{internal_artifact_id}"

headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://eu.whitecircle.com/api/artifact/{internal_artifact_id}', 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://eu.whitecircle.com/api/artifact/{internal_artifact_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://eu.whitecircle.com/api/artifact/{internal_artifact_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://eu.whitecircle.com/api/artifact/{internal_artifact_id}")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/artifact/{internal_artifact_id}")

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

request = Net::HTTP::Get.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'

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

{
  "policies": {},
  "kind": "<string>",
  "status": "<string>",
  "internal_artifact_id": "<string>",
  "flagged": true,
  "updated_at": "<string>",
  "external_artifact_id": "<string>",
  "external_session_id": "<string>",
  "internal_session_id": "<string>",
  "created_at": "<string>",
  "note": "<string>"
}

First Steps

Use Cases

Integrations

Events

Conditions

Artifacts

Policy

Metric

User

Route Shapes

Example Requests

Response Overview

Authorizations

Headers

Path Parameters

Query Parameters

Response

​Route Shapes

​Example Requests

​Response Overview

Authorizations

Headers

Path Parameters

Query Parameters

Response

Route Shapes

Example Requests

Response Overview