POST/api/v1/firewall/check

Run firewall scan against text input

Synchronous firewall scan: runs all enabled layers against the prompt and returns verdict (allow | block) plus per-layer findings. Public p95 SLA: 50 ms. Real CI baseline: 1.13 ms (see scripts/.firewall-latency-baseline.json + ADR-equivalent commit e4191360 for the regression-gate ratchet).

Authentication

Send Authorization: Bearer YOUR_API_KEY on every request. Generate API keys at /dashboard/api-keys.

Request body required

Example

{
  "text": "<User-supplied prompt or assistant output>",
  "layers": [
    "pattern"
  ]
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "required": [
        "text"
      ],
      "properties": {
        "text": {
          "type": "string",
          "description": "User-supplied prompt or assistant output to scan."
        },
        "layers": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": [
              "pattern",
              "token",
              "semantic",
              "output"
            ]
          },
          "description": "Optional subset of layers to run (default: all enabled)."
        }
      }
    }
  }
}

Response

200 example

{
  "success": true
}

All status codes

200Scan result.
400(no description)
401(no description)
429(no description)

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/firewall/check \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "<User-supplied prompt or assistant output>", "layers": [ "pattern" ] }'

TypeScript

import { EvalGuard } from "@evalguard/sdk";

const client = new EvalGuard({ apiKey: process.env.EVALGUARD_API_KEY });

const response = await client.request({
  method: "POST",
  path: "/api/v1/firewall/check",
  body: {
    "text": "<User-supplied prompt or assistant output>",
    "layers": [
      "pattern"
    ]
  },
});
console.log(response);

Python

from evalguard import EvalGuard
import os

client = EvalGuard(api_key=os.environ["EVALGUARD_API_KEY"])

response = client.request(
    method="POST",
    path="/api/v1/firewall/check",
    body={
    "text": "<User-supplied prompt or assistant output>",
    "layers": [
        "pattern"
    ]
},
)
print(response)

Go

package main

import (
	"context"
	"fmt"
	"os"

	"github.com/evalguard/evalguard-go"
)

func main() {
	client := evalguard.NewClient(os.Getenv("EVALGUARD_API_KEY"))
	resp, err := client.Request(context.Background(), "POST", "/api/v1/firewall/check", map[string]any{"text": "<User-supplied prompt or assistant output>", "layers": []any{"pattern"}})
	if err != nil { panic(err) }
	fmt.Println(resp)
}

Errors

400401429

Other Firewall endpoints