Cygnal Monitor

Monitors content for policy violations.

This endpoint is used to check if the provided text contains harmful content or violates the configured policy.

Docs: Guide | API Reference

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

text?string|null

messages?array<>|array<>|null

tools?array<unknown>|null

metadata?|null

categories?|null

rules?|null

reasoning_mode?|

Default"off"

policy_id?|

Policy ID to apply to the monitor request. Required. Cygnal does not apply a default policy.

scanner_configs?array<>|null

litellm_metadata?|null

Response Body

`application/json`

curl -X POST "https://example.com/cygnal/monitor" \  -H "Content-Type: application/json" \  -d '{}'

{  "violation": 0,  "observe_violation": 0,  "violated_rules": [],  "violated_rule_descriptions": [],  "ipi": false,  "mutation": false,  "scanner_output": {},  "reasoning": "string",  "input_tokens": 0,  "output_tokens": 0,  "activity_id": "string",  "error": false,  "error_message": "string"}

Request Body

Response Body

200application/json

400application/json

401application/json

422application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`