Skip to main content
POST
Preview Overlay

Authorizations

X-API-Key
string
header
required

PromptGuard API key for developer endpoints. Keys start with pg_live_ and are created in the dashboard.

Body

application/json
delta
OverlayDelta · object
required

Additive deltas over a base policy config.

Everything here is meant to tighten. Loosening ops (raising a threshold, dropping a detection level toward permissive, disabling a guardrail) are permitted to be expressed but are flagged as warnings in the diff.

sample
SampleSource · object

Where the shadow traffic sample comes from.

corpus reuses the curated Shadow eval corpus (offline, deterministic); inline lets the caller pass their own recent-traffic prompts.

max_examples
integer
default:5
Required range: 1 <= x <= 50
project_id
string | null

Response

Successful Response

total
integer
required
counts
Counts · object
required
blocked_base
integer
required
blocked_candidate
integer
required
warnings
OverlayWarningOut · object[]
required
examples
Examples · object
required