Skip to main content
POST
/
v1
/
guard
Evaluate
curl --request POST \
  --url https://api.guardion.ai/v1/guard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "user",
      "content": "<string>"
    }
  ],
  "session": null,
  "override_enabled_policies": [],
  "override_response": null,
  "fail_fast": true,
  "breakdown_all": false,
  "application": "<string>"
}
'
{
  "time": 123,
  "created": 123,
  "flagged": true,
  "object": "eval",
  "breakdown": [
    {
      "policy_id": "<string>",
      "detector": "<string>",
      "detected": true,
      "threshold": 123,
      "score": 123,
      "result": [
        "<unknown>"
      ]
    }
  ],
  "correction": {
    "choices": [
      {
        "role": "user",
        "content": "<string>"
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
messages
Messages · object[]
required

Rails and policies will be evaluated based on the messages. Policies requires at least the user and assistant, and system message is optional.

session
string | null

Unique session ID for the evaluation

Example:

null

override_enabled_policies
string[] | null
override_response
string | null
Example:

null

fail_fast
boolean
default:true
breakdown_all
boolean
default:false
application
string | null

Response

Successful Response

time
number
required
created
integer
required
flagged
boolean
required
object
string
default:eval
breakdown
Breakdown · object[] | null
correction
Correction · object