---
title: "Detect PII"
method: POST
path: "/v2/pii/detect"
---

# Detect PII

`POST /v2/pii/detect`

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

## Request body

- DetectRequest — The workspace is resolved from the API key, never sent in the body.
  - `text` string — Text to analyse.
  - `language` string — BCP-47 language code. Unset means auto-detect.
  - `threshold` number, double — Global minimum recognizer score (0.0-1.0). Unset uses the provider default.
  - `include_entities` boolean — When true, the response includes a per-type entity breakdown.

## Response `200`

OK

- DetectResponse
  - `has_pii` boolean
  - `entities` object — Per-entity-type counts. Populated only when include_entities was set.

---

[API](https://skmtc.net/orq-ai/apis/orq-ai-api.md) · [All operations](https://skmtc.net/orq-ai/apis/orq-ai-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/orq-ai/orq-ai-api/revisions/2cd7e7f7bcb4/schema)