Skip to content
POST/api/v1/firewall/on-device

Upload on-device firewall telemetry

Runs the on-device guardrail checks server-side against a supplied prompt and returns the verdict. Body: `input` (1..1,000,000 chars, required — this is prompt CONTENT, not telemetry), optional `checks` (<= 50 check names) and `strictMode`. `checks` is accepted by the schema and then DISCARDED — `guard()` reads `enabledChecks`, so the default check set always runs and only `strictMode` overrides. Merges the request over `ON_DEVICE_DEFAULT_CONFIG` and returns the `guard()` result. Nothing is stored and no centralized pattern set is updated. Authenticated.

Authentication

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

Request body required

Example

{
  "input": "string",
  "checks": [
    "string"
  ],
  "strictMode": false
}
Schema
{
  "application/json": {
    "schema": {
      "type": "object",
      "properties": {
        "input": {
          "type": "string",
          "minLength": 1,
          "maxLength": 1000000
        },
        "checks": {
          "maxItems": 50,
          "type": "array",
          "items": {
            "type": "string",
            "maxLength": 120
          }
        },
        "strictMode": {
          "type": "boolean"
        }
      },
      "required": [
        "input"
      ],
      "additionalProperties": false
    }
  }
}

Response

All status codes

200OK.
204Telemetry recorded.
400(no description)
401(no description)
403Forbidden — the credential is valid but lacks the API-key scope, member role, or plan entitlement this operation requires.
429(no description)
500Internal Server Error — an unhandled error was converted to the standard error envelope (INTERNAL_ERROR).

Code samples

cURL

curl -X POST \
  https://evalguard.ai/api/v1/firewall/on-device \
  -H "Authorization: Bearer $EVALGUARD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "input": "string", "checks": [ "string" ], "strictMode": false }'

TypeScript

// The TypeScript SDK (@evalguard/sdk) exposes TYPED methods — runEval,
// getEval, runSecurityScan, checkFirewall, … — not a generic request().
// For an arbitrary endpoint, call it directly:

const res = await fetch("https://evalguard.ai/api/v1/firewall/on-device", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.EVALGUARD_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "input": "string",
    "checks": [
      "string"
    ],
    "strictMode": false
  }),
});
console.log(res.status, await res.json());

Python

# The Python SDK (pip install evalguardai) exposes TYPED methods on
# EvalGuardClient — run_eval, get_eval, … — not a generic request().
# For an arbitrary endpoint, call it directly:

import os
import requests

headers = {"Authorization": f"Bearer {os.environ['EVALGUARD_API_KEY']}"}
headers["Content-Type"] = "application/json"

response = requests.request(
    "POST",
    "https://evalguard.ai/api/v1/firewall/on-device",
    headers=headers,
    json={
    "input": "string",
    "checks": [
        "string"
    ],
    "strictMode": False
},
)
print(response.status_code, response.json())

Go

package main

import (
	"context"
	"fmt"
	"net/http"
	"os"
	"strings"
)

func main() {
	body := strings.NewReader(`{"input":"string","checks":["string"],"strictMode":false}`)
	req, _ := http.NewRequestWithContext(context.Background(), "POST", "https://evalguard.ai/api/v1/firewall/on-device", body)
	req.Header.Set("Authorization", "Bearer "+os.Getenv("EVALGUARD_API_KEY"))
	req.Header.Set("Content-Type", "application/json")
	resp, err := http.DefaultClient.Do(req)
	if err != nil { panic(err) }
	defer resp.Body.Close()
	fmt.Println(resp.Status)
}

Errors

400401403429500

Other Firewall endpoints