Skip to main content
POST
cURL
image_url and input_image content parts are not supported. To submit images, use the artifact API or a newer session API version with artifact content parts.

Authorizations

Authorization
string
header
required

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

Headers

whitecircle-version
string
required

API Version

Body

application/json
messages
object[]
required

Array of chat messages to analyze for policy violations. Required

external_id
string | null

Optional external identifier for tracking this session. Useful for correlating results with your own systems

include_context
boolean | null

Include previous conversation context associated with the same external_id. Default: false.

include_policy_names
boolean | null

Include human-readable policy names in the response. Default: false.

metadata
object

Optional metadata object for additional info about session.

policies
string[] | null

Optional list of specific policy IDs to check. If omitted, all deployment policies are used.

Response

Success

internal_id
string
required

Unique internal identifier for this check

violation
boolean
required

Whether any policy violations were detected

violations
object
required

Map of policy IDs to policy status objects containing violation and optional name

external_id
string | null

Optional external identifier provided by client