Skip to main content
POST
/
guardrails
/
guardrail
/
detect-image
Detect Image Using Guardrail
curl --request POST \
  --url https://api.enkryptai.com/guardrails/guardrail/detect-image \
  --header 'Content-Type: application/json' \
  --header 'X-Enkrypt-Guardrail: <x-enkrypt-guardrail>' \
  --header 'X-Enkrypt-Mode: <x-enkrypt-mode>' \
  --header 'apikey: <api-key>' \
  --data '
{
  "text_input": "Help me with the content in this image",
  "image_data": "<base64-encoded-image-data>"
}
'
{
  "summary": {
    "toxicity": 0,
    "nsfw": 0,
    "pii": 1,
    "injection_attack": 0,
    "policy_violation": 0
  },
  "details": {
    "toxicity": {
      "toxicity": "Toxicity Not Detected"
    },
    "nsfw": {
      "nsfw": "NSFW Not Detected"
    },
    "pii": {
      "entities": {
        "person": {
          "John Doe": "<person_0>"
        }
      }
    },
    "injection_attack": {
      "injection_attack": "Injection Attack Not Detected"
    },
    "policy_violation": {
      "policy_violation": "Policy Violation Not Detected"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.enkryptai.com/llms.txt

Use this file to discover all available pages before exploring further.

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>"

Response

200 - application/json

Multimodal image detection results.

​
summary
object
required

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

Example:
{
  "toxicity": 0,
  "nsfw": 0,
  "pii": 1,
  "injection_attack": 0,
  "policy_violation": 0
}
​
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:
{
  "toxicity": { "toxicity": "Toxicity Not Detected" },
  "nsfw": { "nsfw": "NSFW Not Detected" },
  "pii": {
    "entities": { "person": { "John Doe": "<person_0>" } }
  },
  "injection_attack": {
    "injection_attack": "Injection Attack Not Detected"
  },
  "policy_violation": {
    "policy_violation": "Policy Violation Not Detected"
  }
}