Verify content

Verify content API endpoint allows to verify LLM response against your custom policies

POST /v1/{team_id}/verify

Try it

cURL

cURL

curl --request POST \
  --url https://api.naviml.com/v1/{team_id}/verify \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "messages": [
    {
      "role": "user",
      "content": "<string>"
    }
  ],
  "verifiers": [
    {
      "id": "<string>",
      "type": "policy-verifier",
      "parameters": {
        "threshold": 0.5
      }
    }
  ],
  "explain": true
}
'

200

{
  "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "action": "allow",
  "result": {
    "verifiers": [
      {
        "id": "<string>",
        "result": "<string>",
        "action": "allow",
        "explanation": {
          "text": "<string>"
        },
        "details": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 123,
          "total_tokens": 123
        }
      }
    ],
    "action": "allow"
  }
}

This endpoint allows to run multiple verifiers against a single LLM response. The response will contain the result of each verifier and the final action based on the verifiers’ results.

Authorizations

Authorization · string · header · required

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

Path Parameters

team_id · string · required

Team ID of the team owning the resources and under which the verifiers are executed

Body

application/json

messages · object[] · required

List of messages to run verifiers against

Show child attributes

messages. role · enum<string> · required

Available options: user, assistant

messages. content · string · required

verifiers · object[] · required

List of verifiers to execute with configurations

Option 1

Show child attributes

verifiers. id · string · required

ID of the policy verifier in the system

verifiers. type · enum<string> · required

Available options: policy-verifier

verifiers. parameters · object · required

Show child attributes

verifiers.parameters. threshold · number

Threshold for the policy verifier

Required range: 0 <= x <= 1

explain · boolean

Includes explanation for the result in response

Response

200

*/*

OK

request_id · string<uuid> · required

Unique identifier for the request

action · enum<string> · required

Suggested action based on the result

Available options: allow, modify, deny

result · object · required

Show child attributes

result. verifiers · object[] · required

Show child attributes

result.verifiers. id · string · required

ID of the verifier

result.verifiers. result · string · required

Plaintext result of the verifier

result.verifiers. action · enum<string> · required

Suggested action based on the result

Available options: allow, modify, deny

result.verifiers. explanation · object

Object encapsulating explanation of the result

Show child attributes

result.verifiers.explanation. text · string

Explanation of the result in plain text

result.verifiers. details · object

Verifier specific execution details

result.verifiers. usage · object

Usage of tokens by the request

Show child attributes

result.verifiers.usage. prompt_tokens · integer<int32>

Number of tokens used for the prompt

result.verifiers.usage. completion_tokens · integer<int32>

Number of tokens used for the completion

result.verifiers.usage. total_tokens · integer<int32>

Total number of tokens used

result. action · enum<string> · required

Suggested action based on the result

Available options: allow, modify, deny