Prompt-Protect API

Prompt-Protect API

Description

Field Descriptions

Input Fields

Response Fields

Scorecard Fields

Example Request

curl --request POST \
     --url https://api.witnessai.yourco.com/v1/guardrail/prompt-protect \
     --header 'accept: application/json' \
     --header 'authorization: bearer your-authenticaton-token' \
     --header 'content-type: application/json' \
     --data '
{
  "text": "payment American Express: 3714-496353-98431 or 371449635398431",
  "provider_name": "openai",
  "model_name": "gpt-4o",
  "user": {
    "email": "admin@yourco.com"
  },
  "caller": {
    "application_name": "Custom App",
    "application_version": "v1.0.1"
  }
}
'

Example 200 Response

{
  "request_id": "f0078d68-0100-0000-0000-00007845779e",
  "conversation_id": "f0078d68-0700-0000-0000-000023cf7b99",
  "text": "payment American Express: [TEMPLATE_CREDIT_CARD_2] or [TEMPLATE_CREDIT_CARD_1]",
  "report": {
    "score_cards": [
      {
        "id": "f0078d68-0c00-0000-0000-00003bd96865",
        "prompt_id": "f0078d68-0100-0000-0000-00007845779e",
        "report_type": "",
        "started_at": "2025-08-01T18:31:12.358245Z",
        "completed_at": "2025-08-01T18:31:12.366365Z",
        "data_modified": true,
        "confidence": 100,
        "risk_score": 3,
        "risk_type": "Data Leakage",
        "risk_metric": "High",
        "message": "input required anonymization",
        "result": "pass",
        "filter_identifier": "fl-pre-anonymizer",
        "rule_result": "warn",
        "rule_message": "Data Protection set to Warn Action ."
      },
      {
        "id": "f0078d68-0c00-0000-0000-000018423116",
        "prompt_id": "f0078d68-0100-0000-0000-00007845779e",
        "report_type": "",
        "started_at": "2025-08-01T18:31:12.349592Z",
        "completed_at": "2025-08-01T18:31:12.94504Z",
        "data_modified": false,
        "risk_type": "None",
        "risk_metric": "None",
        "message": "Process financial payment",
        "result": "pass",
        "filter_identifier": "fl-pre-topic-categorizer"
      },
      {
        "id": "f0078d68-0c00-0000-0000-0000009fbefa",
        "prompt_id": "f0078d68-0100-0000-0000-00007845779e",
        "report_type": "",
        "started_at": "2025-08-01T18:31:12.350063Z",
        "completed_at": "2025-08-01T18:31:12.410792Z",
        "data_modified": false,
        "risk_type": "None",
        "risk_metric": "None",
        "message": "prompt injection was not detected",
        "result": "pass",
        "filter_identifier": "fl-pre-risk-analysis"
      },
      {
        "id": "f6078d68-0c00-0000-0000-0000a1fdc565",
        "prompt_id": "f0078d68-0100-0000-0000-00007845779e",
        "report_type": "",
        "started_at": "2025-08-01T18:31:18.854834Z",
        "completed_at": "2025-08-01T18:31:18.918675Z",
        "data_modified": false,
        "risk_type": "None",
        "risk_metric": "None",
        "message": "[]",
        "result": "pass",
        "filter_identifier": "fl-pre-intention-classifier"
      }
    ],
    "warning_count": 0,
    "error_count": 0,
    "incomplete_count": 0,
    "input_score": 0,
    "output_score": 0,
    "combined_score": 0,
    "risk_score": 3,
    "result": "pass"
  },
  "block_flow": false,
  "route": false,
  "text_modified": true,
  "prompt_instructions": "Below is a request that may contain predefined placeholders, such as [TEMPLATE_PERSON_1], [TEMPLATE_CREDIT_CARD_2], etc.,In your response to the request, if your response needs to include a placeholder for context, you must preserve the format by keeping it in uppercase.Do not modify these placeholders in any manner. Do not add any new placeholders.",
  "messages": [
    "Data Protection set to Warn Action ."
  ]
}

HTTP Status Codes