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

# Scan a draft for personal data

> Fast, pattern-based privacy scan of draft text, used while you type. No model is called and nothing is stored. The report gives types, severities and positions, never the matched values. Returns a bare object, not the `{ data }` envelope.

**Auth:** session. **Permission:** signed in.



## OpenAPI

````yaml /api-reference/openapi.json post /chat/scan
openapi: 3.1.0
info:
  title: CorePillar API
  version: 1.0.0
  description: >-
    REST API for AgentHub and ModelHub. Ingestion endpoints authenticate with a
    project tracing key; all other endpoints use the signed-in user's browser
    session.
servers:
  - url: https://pillarforge.corepillar.ai/api/v1
    description: AgentHub
security: []
tags:
  - name: Ingestion
    description: 'Send traces with a tracing key: JSON ingest and OpenTelemetry (OTLP).'
  - name: Traces
    description: Read traces and spans.
  - name: Evaluations
    description: Evaluate traces with evaluator collections.
  - name: Evaluators
    description: Built-in and custom evaluators.
  - name: Evaluator collections
    description: Ordered groups of evaluators.
  - name: Organizations
    description: Organizations you belong to.
  - name: Members
    description: Organization members, invites and roles.
  - name: Projects
    description: Projects inside an organization.
  - name: SSO
    description: Okta SSO configuration.
  - name: Tracing keys
    description: Create, list and revoke project tracing keys.
  - name: Cost calculator
    description: Estimate, generate and execute scenario runs.
  - name: Synthetic
    description: Synthetic agent and data setup from source material.
  - name: Chat
    description: ModelHub chat. Served at https://modelhub.corepillar.ai/api/v1.
  - name: Auth
    description: Sign-in helpers.
  - name: E2E
    description: Internal end-to-end encryption key directory.
paths:
  /chat/scan:
    servers:
      - url: https://modelhub.corepillar.ai/api/v1
        description: ModelHub
    post:
      tags:
        - Chat
      summary: Scan a draft for personal data
      description: >-
        Fast, pattern-based privacy scan of draft text, used while you type. No
        model is called and nothing is stored. The report gives types,
        severities and positions, never the matched values. Returns a bare
        object, not the `{ data }` envelope.


        **Auth:** session. **Permission:** signed in.
      operationId: chatScan
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - text
              properties:
                text:
                  type: string
                  maxLength: 32000
      responses:
        '200':
          description: Scan report.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PiiReport'
        '400':
          description: Malformed request (`INVALID_BODY`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
        '401':
          description: Not signed in (`UNAUTHENTICATED`).
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                      message:
                        type: string
      security:
        - session: []
components:
  schemas:
    PiiReport:
      type: object
      additionalProperties: true
      description: >-
        What the privacy scan found: finding types, severities and offsets.
        Never contains the matched values.
  securitySchemes:
    session:
      type: apiKey
      in: cookie
      name: session
      description: >-
        The session cookie set when you sign in to AgentHub or ModelHub in a
        browser. The cookie name shown here is illustrative. There are no API
        tokens for these endpoints.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.