> ## 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. # Redact PII > Replaces detected PII with placeholders and returns the reverse mapping needed to restore the original text. ## OpenAPI ````yaml post /v2/pii/redact openapi: 3.1.0 info: title: orq.ai API version: '2.0' description: orq.ai API documentation servers: - url: https://my.orq.ai security: - ApiKey: [] tags: - name: Chunking description: Split text into smaller chunks for retrieval and generation workflows. - name: File Systems description: >- Create and manage persistent file systems that agents and MCP clients read from and write to. - name: Knowledge Bases description: Create and manage knowledge bases used by agents and retrieval workflows. - name: Memory Stores description: Create and manage memory stores, memories, and memory documents. - name: Evals description: Run an evaluator against a conversation and its result - name: Logs description: >- OpenTelemetry log query API. Search, filter, aggregate, and facet log records ingested via OTLP. - 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. - name: Traces description: >- Query and inspect ingested trace data: search trace summaries, aggregate metrics, and read individual traces and their spans. - description: List models available through the AI Router. name: Models - name: Policies - name: Alerts description: >- Alerts evaluate a Reporting API metric on a fixed interval and fire notifications through notifiers when the value breaches a threshold. Each breach opens a trigger that tracks the incident until the value recovers. - name: Annotation Queues description: Annotation queues collect spans for human review. - name: API keys description: >- API keys authenticate programmatic access to the workspace. They expose opaque tokens, per-domain access grants, and budget and rate-limit constraints. - name: Audit Logs description: Audit logs record workspace entity changes and access-relevant events. - name: Budgets description: >- Budgets govern spend, token usage, and request rate across six scopes: workspace, project, identity, API key, provider, and model. Every applicable budget is enforced, and the most restrictive limit applies per dimension. - name: Files description: File upload and retrieval operations. - name: Guardrail Rules description: >- Guardrail Rules conditionally enforce evaluators and plugins for AI Gateway traffic. Rules may be scoped to a project or the whole workspace. - name: Hub description: Hub items are reusable templates available to a workspace. - name: Identities description: >- Identities represent end users from your system for usage and engagement tracking. - name: Management keys description: >- Management keys are workspace-scoped credentials that authenticate programmatic access to workspace administration surfaces (API keys, budgets). Unlike project-scoped API keys, a management key always operates at the workspace level. - name: MCP Gateway description: >- Register upstream MCP servers, discover and sync their tools, and assemble gateways that expose a curated tool surface to MCP clients. - name: Model Catalog description: >- Browse the orq.ai model catalog: every model orq offers, across every provider, with pricing, capabilities and benchmark data. List endpoints only return models that are not deprecated. This API is public, requires no authentication, and is rate limited to 120 requests per minute per IP. Responses carry a 5-minute cache-control max-age. - name: Notifiers description: Notifier destinations used to send delivery and workflow notifications. - name: Projects description: Projects organize resources within a workspace - name: Routing Rules description: >- Routing Rules conditionally select models and enforce request plugins for AI Gateway traffic. Rules are evaluated by ascending priority and may be scoped to a project or the whole workspace. - name: Threads description: Threads group related trace invocations and their aggregate usage - name: Skills description: >- Skills are modular instructions you can use to codify processes and conventions - name: Smart Routers description: >- Create and manage workspace Smart Routers. A Smart Router selects a model from an eligible pool for each request according to a quality, balanced, or cost profile. - name: Webhooks description: >- Create and manage webhooks that deliver workspace events to external HTTPS endpoints. - name: Workspaces description: >- A workspace is the tenant. Create is a user-session onboarding RPC; Get, List, and Update are the public management surface. - name: Workspace Security description: >- Workspace-level domain verification and IP allowlist controls. These operations are restricted to workspace administrators. - name: Workspace Settings description: >- Workspace-level settings managed with a workspace credential. A workspace is the tenant, so these settings are a singleton — there is nothing to create or delete, only read and update. - name: Responses - description: Run agents on a cron cadence. Minimum firing interval is 1 hour. name: Agent Schedules - name: Embeddings externalDocs: url: https://docs.orq.ai description: orq.ai Documentation paths: /v2/pii/redact: post: tags: [] summary: Redact PII description: >- Replaces detected PII with placeholders and returns the reverse mapping needed to restore the original text. operationId: PIIRedact requestBody: content: application/json: schema: $ref: '#/components/schemas/RedactRequest' required: true responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/RedactResponse' x-code-samples: - lang: typescript label: Node.js source: > await orq.pii.redact({ text: "Jane Doe, BSN 123456782", entities: ["PERSON", "BSN"] }); components: schemas: RedactRequest: type: object properties: text: type: string language: type: string threshold: type: number format: double regions: type: array items: type: string description: >- Region codes selecting whole regions of coverage, e.g. "nl", "gb". Every entity type those regions cover is included, alongside the base catalog. ["all"] is exclusive. Leaving this and `entities` both empty also runs every region, so selecting nothing is the widest request rather than the narrowest. Empty alongside a non-empty `entities` stays strict. See the capabilities endpoint for the region list. Combines with `entities`: the detector unions the two selections, so a request carrying both covers the regions plus the named types. Note that `entities` only narrows coverage when it travels alone. entities: type: array items: type: string description: >- The entity types to cover. A named type fires even when it belongs to a region, so a region's types can be selected individually without naming the region. Alone this is a strict allowlist; alongside `regions` it adds to the region coverage instead of narrowing it. entity_thresholds: type: object additionalProperties: type: number format: double description: >- Per-entity confidence cutoff overrides. An override REPLACES the global `threshold` for that type and may sit above or below it: the gateway lowers the first-pass floor it sends the detector to the smallest value in the map, and every selected type carries its own cutoff, so a sub-global override detects MORE of that type without widening the rest. This only tunes confidence; it never changes which types are covered. Coverage is decided by `entities` alone, so every key here must also appear in `entities` — a key that does not is rejected, as is any key at all when `entities` is empty. Declarative [0,1] bound mirrors existing constraint on `threshold`. RedactResponse: type: object properties: redacted_text: type: string mappings: type: object additionalProperties: type: string description: >- Maps each placeholder (e.g. "") to the original value it replaced. securitySchemes: ApiKey: type: http scheme: bearer bearerFormat: JWT ````