> ## 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.

# Health status

> Returns system health status. Unauthenticated requests use cache; authenticated requests perform real-time checks.



## OpenAPI

````yaml /api-reference/openapi.json get /health/
openapi: 3.1.0
info:
  title: Nvisy API
  summary: Document processing and annotation platform
  description: >-
    Nvisy provides intelligent document processing, annotation, and analysis
    capabilities. This API enables document upload, OCR processing, embedding
    generation, and semantic search across your document collections.
  termsOfService: https://nvisy.com/legal/terms-of-service
  contact:
    name: Nvisy Support
    url: https://nvisy.com
    email: hello@nvisy.com
  license:
    name: Proprietary
    url: https://nvisy.com/license
  version: 0.1.0
servers: []
security: []
tags:
  - name: Accounts
    description: Account management and profile operations
  - name: Authentication
    description: Login, signup, and token management
  - name: Workspaces
    description: Workspace creation and management
  - name: Files
    description: File upload, download, and management
  - 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: Pipelines
    description: Redaction pipeline configuration
  - name: Pipeline Runs
    description: Pipeline run execution and review
  - name: Policies
    description: Redaction policy configuration
  - name: Webhooks
    description: Webhook configuration
  - name: Notifications
    description: Account notification management
  - name: Health
    description: Service health checks
paths:
  /health/:
    get:
      tags:
        - Health
      summary: Health status
      description: >-
        Returns system health status. Unauthenticated requests use cache;
        authenticated requests perform real-time checks.
      parameters:
        - in: path
          name: version
          description: The API version string (e.g., "v1", "v2").
          required: true
          schema:
            description: The API version string (e.g., "v1", "v2").
            type: string
          style: simple
      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'
      security:
        - BearerAuth: []
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

````