Skip to main content
GET
Get artifact by ID
Retrieve the results of a previously submitted artifact check. Use this endpoint to look up artifact policy check results using either the system-generated ID or your custom tracking identifier.

Query Parameters

*Exactly one of internal_artifact_id or external_artifact_id is required.
For precise lookups, prefer internal_artifact_id over external_artifact_id.
When using external_artifact_id with multiple matches, the most recently created artifact within the same deployment is returned.

Example Requests

Using the internal artifact ID:
Using your external artifact ID:

Response Overview

Each policy in the policies object includes:
  • name — Human-readable policy name
  • flagged — Whether this specific policy was violated
  • flagged_source — Array of content types that triggered the violation (e.g., ["image"])

Authorizations

Authorization
string
header
required

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

Headers

whitecircle-version
string
required

API Version

Query Parameters

internal_artifact_id
string | null
external_artifact_id
string | null
deployment_id
string | null

Response

Artifact found

Artifact check result.

status
string
required

Check status: "completed"

policies
object
required

Map of policy ID to violation result

internal_artifact_id
string
required

System-generated UUID for this artifact

kind
string
required

Echo of content.kind from request

flagged
boolean | null

true if any policy was violated

external_artifact_id
string | null

Your custom artifact ID (if provided)

internal_session_id
string | null

Internal ID of the linked session (if attached)

external_session_id
string | null

External ID of the linked session (if provided)

created_at
string | null

ISO 8601 creation timestamp

updated_at
string | null

ISO 8601 last update timestamp

note
string | null

Informational note (only present when applicable)