Check Artifact
Check a single content artifact against deployment policies. Currently supports image artifacts.
How It Works
- You submit a content artifact (e.g., an image via URL or base64)
- White Circle analyzes the content against applicable policies configured in your deployment
- You receive a synchronous response with policy violations
mime_type is optional for all submission methods. White Circle detects the image format automatically from the content bytes.Request Overview
Response Overview
policies object includes:
name— Human-readable policy nameflagged— Whether this specific policy was violatedflagged_source— Array of content types that triggered the violation (e.g.,["image"])
Artifact Statuses
"completed".External Artifact ID
Useexternal_artifact_id to track artifacts with your own identifiers. This is useful for:
- Deduplicating checks for the same content
- Looking up results later via Get Artifact Results
- Referencing the artifact in session checks by your own ID
external_artifact_id, the most recently created one within the deployment is returned on lookup.Attach to a Session
You can optionally attach an artifact to an existing session by providinginternal_session_id or external_session_id. This connects the artifact to the session for tracking and analytics.
Role-Based Filtering
Therole field controls which policies are evaluated against the artifact based on each policy’s Applies To setting (input, output, or any).
"user" for user-uploaded images and "assistant" for AI-generated images.
"user-12345", "assistant-v2") are normalized to their base role. Invalid role values are treated the same as omitting the field.
Content Constraints
Authorizations
API Key required. Format: Bearer wc-your-api-key
Headers
API Version
Body
Request body for checking a content artifact.
Artifact content payload. See Content Constraints in the docs for supported formats and limits.
The deployment ID to check against
Your custom artifact tracking ID
Attach artifact to an existing session by your external session ID
Attach artifact to an existing session by internal UUID
Arbitrary key-value metadata
Response
Artifact check completed
Artifact check result.
Check status: "completed"
Map of policy ID to violation result
System-generated UUID for this artifact
Echo of content.kind from request
true if any policy was violated
Your custom artifact ID (if provided)
Internal ID of the linked session (if attached)
External ID of the linked session (if provided)
ISO 8601 creation timestamp
ISO 8601 last update timestamp
Informational note (only present when applicable)
