Interactions | HiddenLayer Documentation

curl -X POST https://api.hiddenlayer.ai/detection/v1/interactions \
     -H "HL-Project-Id: internal-search-chatbot" \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "metadata": {
    "model": "gpt-5",
    "requester_id": "user-1234",
    "provider": "openai"
  }
}'

{
  "metadata": {
    "provider": "openai",
    "model": "gpt-5",
    "requester_id": "user-1234",
    "project": {
      "project_id": "ca87b009-90bd-4724-91c2-f23326acd51a",
      "project_alias": "enterprise-search",
      "ruleset_id": "b5d7d261-b7be-451a-b943-0d408ab88aab"
    },
    "processing_time_ms": 15.34,
    "event_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "analyzed_at": "2023-10-10T14:48:00.000Z"
  },
  "analysis": [
    {
      "name": "string",
      "phase": "string",
      "version": "string",
      "detected": true,
      "configuration": {},
      "findings": {
        "frameworks": {}
      },
      "processing_time_ms": 1.1,
      "id": "string"
    }
  ],
  "analyzed_data": {
    "input": {
      "messages": [
        {
          "content": "What the largest moon of jupiter?",
          "role": "user"
        }
      ]
    },
    "output": {
      "messages": [
        {
          "content": "The largest moon of Jupiter is Ganymede.",
          "role": "assistant"
        }
      ]
    }
  },
  "modified_data": {
    "input": {
      "messages": [
        {
          "content": "What the largest moon of jupiter?",
          "role": "user"
        }
      ]
    },
    "output": {
      "messages": [
        {
          "content": "The largest moon of Jupiter is Ganymede.",
          "role": "assistant"
        }
      ]
    }
  },
  "evaluation": {
    "action": "Allow",
    "has_detections": false,
    "threat_level": "None"
  }
}

Performs a detailed security analysis of the input and/or output of LLM interactions.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

metadataobjectRequired

inputobjectOptional

outputobjectOptional

Response

Successful Response

metadataobject

analysislist of objects

analyzed_dataobject

The language model input and/or output that was analyzed.

modified_dataobject

The potentially modified language model input and output after applying any redactions or modifications based on the analysis.

evaluationobjectOptional

The evaluation of the analysis results.

Errors

422

Unprocessable Entity Error

Authentication

Headers

Request

Response

Errors