Sign in

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
policy_version_idstring nullable

Evaluate against the policy as it existed at this version. Requires exactly one policy (policy_id or a single-element policy_ids) and is incompatible with no_policy and agent-attached policies.

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

Changes

Changed in 1 of the 3 revisions of this API.2

  • e2fea3e430442See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the optional property /// to the response with the status

      response-optional-property-added