Evaluate Request | HiddenLayer Documentation

curl -X POST https://api.hiddenlayer.ai/detection/v2/request-evaluations \
     -H "HL-Project-Id: internal-search-chatbot" \
     -H "HL-Runtime-Session-Id: sess_4b8cde94604f4c389406a0b2f806069a" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "model": "gpt-4",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "What is the capital of France?"
    }
  ],
  "max_tokens": 1000,
  "temperature": 0.7
}'

{
  "model": "gpt-4",
  "messages": [
    {
      "role": "system",
      "content": "You are a helpful assistant."
    },
    {
      "role": "user",
      "content": "What is the capital of France?"
    }
  ],
  "max_tokens": 1000,
  "temperature": 0.7
}

[BETA] This endpoint is not GA or Production ready and is subject to changes at any time. Breaking changes may occur.

Analyzes an LLM request payload for security threats before it is sent to the model.

Accepts any valid provider request payload and returns:

If detect or redact action: the request payload (potentially modified) in the provider’s request format
If block action: a canned block message in the provider’s response format

Use this endpoint inline in your LLM pipeline to evaluate prompts before they reach the model.

Supported provider formats:

Authentication

AuthorizationBearer

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

Request

This endpoint expects a map from strings to any.

Response headers

HL-Runtime-ActionstringOptional

The action recommended by the policy engine evaluation outcome. It is set to BLOCK when a detection rule is triggered for a block action.

Response

Successful evaluation. Returns the (potentially modified) provider request payload, or if a block action was taken, a provider response payload.

Authentication

Headers

Request

Response headers

Response