Artifacts

Get Artifact Results by ID

Retrieve artifact check results by internal_artifact_id or external_artifact_id.

GET
/api/artifact/get_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

ParameterRequiredDescription
internal_artifact_id✓*System-generated UUID returned in the artifact check response.
external_artifact_id✓*Your custom tracking ID passed when checking the artifact.
deployment_idOverride deployment resolved from your API key. Defaults to the deployment associated with your API key.

*Exactly one of internal_artifact_id or external_artifact_id is required.

Example Requests

Using the internal artifact ID:

cURL

curl -X GET "https://eu.whitecircle.com/api/artifact/get_by_id?internal_artifact_id=a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "whitecircle-version: 2025-12-01"

Using your external artifact ID:

cURL

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

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: "2025-12-01"

Query Parameters

  • internal_artifact_idstring | null

  • external_artifact_idstring | null

  • deployment_idstring | null

Response

application/json

Artifact found

Artifact check result.

  • statusstringrequired

    Check status: "completed"

  • policiesobjectrequired

    Map of policy ID to violation result

    Show child attributes
    • policies.{key}object

      Policy violation result for an artifact check.

      Show child attributes
      • policies.{key}.flaggedbooleanrequired

        Whether this policy was violated

      • policies.{key}.flagged_sourcestring[]required

        Content types that triggered the violation (e.g., ["image"])

      • policies.{key}.namestringrequired

        Policy display name

  • internal_artifact_idstringrequired

    System-generated UUID for this artifact

  • kindstringrequired

    Echo of content.kind from request

  • flaggedboolean | null

    true if any policy was violated

  • external_artifact_idstring | null

    Your custom artifact ID (if provided)

  • internal_session_idstring | null

    Internal ID of the linked session (if attached)

  • external_session_idstring | null

    External ID of the linked session (if provided)

  • created_atstring | null

    ISO 8601 creation timestamp

  • updated_atstring | null

    ISO 8601 last update timestamp

  • notestring | null

    Informational note (only present when applicable)