Artifacts

Get Artifact Results

GET
/api/artifact/{internal_artifact_id}

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:

RouteUse 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

deployment_id remains optional on both routes. If you omit it, White Circle uses the deployment associated with your API key.

Example Requests

Using the internal artifact ID:

cURL

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-04-15"

Using your external artifact ID:

cURL

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-04-15"

Example Response

JSON

{
  "flagged": true,
  "policies": {
    "4d7543e2-d106-4cac-b0a4-87b27e473813": {
      "name": "No Explicit Content",
      "flagged": true,
      "flagged_source": ["image"]
    },
    "d54a96f1-ccac-4967-9101-46e68eab415e": {
      "name": "No Violence",
      "flagged": false,
      "flagged_source": []
    }
  },
  "kind": "image",
  "status": "completed",
  "updated_at": "2026-04-15T10:30:00Z",
  "internal_artifact_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "external_artifact_id": "user-avatar-42",
  "external_session_id": "user-session-123",
  "internal_session_id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2026-04-15T10:30:00Z",
  "note": null
}

Response Overview

FieldTypeDescription
flaggedboolean | nulltrue if any policy was violated. null while processing or on failure.
policiesobjectMap of policy IDs to their violation statuses
kindstringContent type of the artifact (e.g., "image")
statusstringCheck status: "completed", "processing", or "failed"
updated_atstringISO 8601 last update timestamp
internal_artifact_idstringSystem-generated UUID for this artifact
external_artifact_idstringYour custom artifact tracking ID (if provided)
external_session_idstringExternal ID of the linked session (if attached)
internal_session_idstringSystem-generated UUID of the linked session (if attached)
created_atstringISO 8601 creation timestamp
notestringInformational message, included when applicable (e.g. why an image fetch failed)

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

  • Authorizationstringheaderrequired

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

Headers

  • whitecircle-versionstringrequired

    API Version

    Example: "2026-04-15"

Path Parameters

  • internal_artifact_idstringrequired

    Find an artifact by its internal artifact ID

Query Parameters

  • deployment_idstring

    Optional deployment ID to validate artifact ownership

Response

application/json

Success

  • policiesobjectrequired

    Show child attributes
    • policies.{key}object

      Show child attributes
      • policies.{key}.flaggedbooleanrequired

      • policies.{key}.flagged_sourcestring[]required

      • policies.{key}.namestringrequired

  • kindstringrequired

  • statusstringrequired

  • internal_artifact_idstringrequired

  • flaggedboolean | null

  • updated_atstring | null

  • external_artifact_idstring | null

  • external_session_idstring | null

  • internal_session_idstring | null

  • created_atstring | null

  • notestring | null