Skip to main content
POST
Detect Image Using Guardrail

Authorizations

apikey
string
header
required

Headers

X-Enkrypt-Guardrail
string
required

The guardrail name

Example:

"My Guardrail"

X-Enkrypt-Mode
enum<string>
required

Whether to apply input (prompt) or output (response) detectors

Available options:
prompt,
response
Example:

"prompt"

Body

application/json

Request body for guardrail/policy-based image detection. Detectors are defined by the guardrail or policy; no inline detectors config is needed.

text_input
string
required

The text prompt to accompany the image for analysis.

Example:

"Help me with the content in this image"

image_data
string
required

Base64-encoded image file content.

Example:

"<base64-encoded-image-data>"

user_metadata
object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example:

Response

200 - application/json

Multimodal image detection results.

summary
object
required

Per-detector integer flags (1 = detected, 0 = not detected).

Example:
details
object
required

Per-detector detail objects containing human-readable results and any extra fields (e.g. entities for PII, explanation for policy_violation).

Example:
user_metadata
object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example: