> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Detect PII

> Reports whether the supplied text contains personally identifiable information, optionally with a per-type entity breakdown.



## OpenAPI

````yaml post /v2/pii/detect
openapi: 3.1.0
info:
  title: orq.ai API
  version: '2.0'
  description: orq.ai API documentation
servers:
  - url: https://api.orq.ai
security:
  - ApiKey: []
tags:
  - description: List models available through the AI Router.
    name: Models
  - name: Guardrail Rules
  - name: Policies
  - name: Routing Rules
  - name: API keys
    description: >-
      API keys authenticate programmatic access to the workspace. The unified
      key model exposes opaque tokens, per-domain access grants, and budget /
      rate-limit constraints (see ADR 0001 and ADR 0002).
  - name: Budgets
    description: >-
      Budgets govern spend, token usage, and request rate across six scopes:
      workspace, project, identity, api-key, provider, and model. A budget is
      hierarchical and defense-in-depth — every applicable budget is a hard
      gate, and the most restrictive one wins per dimension (see ADR 0007).
  - name: Documentation
    description: >-
      Search the orq.ai documentation. Proxies the workspace's query to the
      hosted docs search index.
  - name: Files
    description: File upload and retrieval operations.
  - name: Identities
    description: >-
      Identities represent end users from your system for usage and engagement
      tracking.
  - name: Projects
    description: Projects organize resources within a workspace
  - name: Skills
    description: >-
      Skills are modular instructions you can use to codify processes and
      conventions
  - name: Responses
  - description: >-
      Run agents on a cadence — cron, interval, or one-off. Minimum firing
      interval is 1 hour.
    name: Agent Schedules
  - name: Embeddings
  - name: Reporting
    description: >-
      GenAI reporting API over canonical analytics rollups. Accepts a metric
      name, time range, grain, group-by, and filters; returns a typed time
      series and optional totals.
externalDocs:
  url: https://docs.orq.ai
  description: orq.ai Documentation
paths:
  /v2/pii/detect:
    post:
      tags: []
      summary: Detect PII
      description: >-
        Reports whether the supplied text contains personally identifiable
        information, optionally with a per-type entity breakdown.
      operationId: PIIDetect
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DetectRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetectResponse'
components:
  schemas:
    DetectRequest:
      type: object
      properties:
        text:
          type: string
          description: Text to analyse.
        language:
          type: string
          description: BCP-47 language code. Unset means auto-detect.
        threshold:
          type: number
          description: >-
            Global minimum recognizer score (0.0-1.0). Unset uses the provider
            default.
          format: double
        include_entities:
          type: boolean
          description: When true, the response includes a per-type entity breakdown.
      description: The workspace is resolved from the API key, never sent in the body.
    DetectResponse:
      type: object
      properties:
        has_pii:
          type: boolean
        entities:
          type: object
          additionalProperties:
            type: integer
            format: int32
          description: >-
            Per-entity-type counts. Populated only when include_entities was
            set.
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````