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

# Readiness probe

> Reports the server's health and that of its dependencies, served from a short-lived cache. 200 when healthy or degraded, 503 when unhealthy. Safe to poll frequently.



## OpenAPI

````yaml /api-reference/openapi.json get /health
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document detection and redaction platform
  description: >-
    Nvisy provides intelligent detection of sensitive content in documents,
    redaction pipelines, and reviewer workflows. This API enables document
    upload, detection analysis, redaction, and collaborative review across your
    workspaces.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  version: 0.1.0
servers: []
security: []
tags:
  - name: Health
    description: Service health checks
  - name: Capabilities
    description: Read-only reference data describing this deployment
  - name: Accounts
    description: Account management and profile operations
  - name: Identities
    description: 'Account sign-in methods: password and linked providers'
  - name: Avatars
    description: Public avatar image serving
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Activities
    description: Workspace activity log and export
  - name: Documents
    description: Document upload, download, and management
  - name: Analytics
    description: Aggregate metrics over a workspace's documents
  - name: Members
    description: Workspace member management
  - name: Invites
    description: Workspace invitation handling
  - name: API Tokens
    description: API token management
  - name: Connections
    description: External provider connections
  - name: Connection Syncs
    description: Connection synchronization runs
  - name: Providers
    description: Inference-provider configuration
  - name: Pipelines
    description: Redaction pipeline configuration
  - name: Detections
    description: Detection analysis and redaction
  - name: Redactions
    description: Redactions produced from a detection, with reviewer edits
  - name: Reviews
    description: Document reviews, the review queue, and their discussion
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
paths:
  /health:
    get:
      tags:
        - Health
      summary: Readiness probe
      description: >-
        Reports the server's health and that of its dependencies, served from a
        short-lived cache. 200 when healthy or degraded, 503 when unhealthy.
        Safe to poll frequently.
      responses:
        '200':
          description: Response body for `GET /health/`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
        '503':
          description: Response body for `GET /health/`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Health'
components:
  schemas:
    Health:
      description: Response body for `GET /health/`.
      type: object
      properties:
        checks:
          description: Per-component health checks.
          type: array
          items:
            $ref: '#/components/schemas/ComponentHealth'
        status:
          description: Overall service status.
          allOf:
            - $ref: '#/components/schemas/HealthStatus'
        timestamp:
          description: RFC 3339 timestamp of when the check was performed.
          type: string
      required:
        - status
        - checks
        - timestamp
    ComponentHealth:
      description: Health of a single service component.
      type: object
      properties:
        name:
          description: Component name (e.g. `"postgres"`, `"nats"`).
          type: string
        status:
          description: Status of this component.
          allOf:
            - $ref: '#/components/schemas/HealthStatus'
      required:
        - name
        - status
    HealthStatus:
      description: Operational status of a service component.
      oneOf:
        - description: Component is operating normally.
          type: string
          const: healthy
        - description: Component is operating with some issues but still functional.
          type: string
          const: degraded
        - description: Component is not operational.
          type: string
          const: unhealthy

````