v1

latestOpenAPI 3.1.02026-08-04197263.3 KB

Cygnal Monitor

Monitors content for policy violations.

This endpoint is used to check if the provided text contains harmful content or violates a given set of policies.

Docs: Guide | API Reference

post/cygnal/monitor

Request body

textstring nullable
toolsMonitorTool[] nullable
metadataobject nullable
reasoning_mode'off' | 'thinking' | 'hybrid' nullable
policy_idstring nullable
policy_idsstring[] nullable
scanner_configsobject[] nullable
litellm_metadataobject nullable

Response

Successful Response

violationnumber
observe_violationnumber nullable
violated_rulesinteger[]
ipiboolean
mutationboolean
scanner_outputobject nullable
reasoningstring nullable
input_tokensinteger nullable
output_tokensinteger nullable
activity_idstring nullable
block_messagestring nullable
errorboolean
error_messagestring nullable