> ## 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.

# Guardrail Scan PDF

> Scan a PDF for security threats using a saved guardrail



## OpenAPI

````yaml POST /guardrails/guardrail/scan-pdf
openapi: 3.0.0
info:
  title: Enkrypt AI APIs
  version: 2.0.0
servers:
  - url: https://api.enkryptai.com
security:
  - apiKeyAuth: []
tags:
  - name: Guardrails
  - name: Code of Conduct
  - name: Endpoints
  - name: Datasets
  - name: Redteam
  - name: Deployments
  - name: AI Proxy
  - name: Leaderboard
  - name: Archived
  - name: MCP Hub
    description: >-
      MCP Hub vulnerability scanning APIs. Submitting scans (the POST endpoints)
      is open to all authenticated callers. The scan **retrieval** APIs — Get
      Scan Job Status, Get Complete Scan Results, List Scans, and Get MCP Hub
      Scan Statistics (the GET endpoints) — are an **enterprise data-license
      feature**: they require your organization to have MCP Hub API access
      enabled by Enkrypt, otherwise they return `403`. Contact us at
      support@enkryptai.com to enable access.
  - name: MCP Registry Servers
  - name: MCP Gateways
  - name: MCP Playground
paths:
  /guardrails/guardrail/scan-pdf:
    post:
      tags:
        - Guardrails
      summary: Scan PDF Using Guardrail
      description: >-
        Scans a PDF for security threats using a guardrail. Use X-Enkrypt-Mode
        to select input (prompt) or output (response) detectors.
      operationId: guardrail_scan_pdf
      parameters:
        - name: X-Enkrypt-Guardrail
          in: header
          required: true
          schema:
            title: Guardrail Name
            type: string
            description: The guardrail name
            example: My Guardrail
        - name: X-Enkrypt-Mode
          in: header
          required: true
          schema:
            title: Mode
            type: string
            enum:
              - prompt
              - response
            description: Whether to apply input (prompt) or output (response) detectors
            example: prompt
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GuardrailScanPdfRequestBody'
      responses:
        '200':
          description: Scan results for the provided PDF using the specified guardrail.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScanPdfResponseBody'
components:
  schemas:
    GuardrailScanPdfRequestBody:
      title: GuardrailScanPdfRequestBody
      type: object
      properties:
        file:
          type: string
          description: Base64-encoded PDF file content.
      required:
        - file
    ScanPdfResponseBody:
      title: ScanPdfResponseBody
      type: object
      required:
        - summary
        - details
      properties:
        summary:
          type: object
          description: Summary counts of detections by detector type.
          additionalProperties:
            type: integer
        details:
          type: object
          description: Detailed scan results including page-level information.
          properties:
            total_pages:
              type: integer
              description: Total number of pages in the PDF.
            pages_with_detections:
              type: integer
              description: Number of pages that had detections.
            detections:
              type: array
              description: List of detections found in the PDF.
              items:
                type: object
                additionalProperties: true
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: apikey

````