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

# Platform Health

> Aggregates MongoDB, Redis, and subsystem readiness and is used by load balancers for health checking.

Returns the aggregated health for the entire Handa Uncle backend: API uptime,
MongoDB, Redis, and any subsystems registered in `startup.config.ts`. Use this
endpoint for synthetic checks and during incident response to understand which
dependency is degraded.

### Example request

```bash theme={null}
curl https://api.handauncle.com/api/v1/health
```

### Response fields

* `data.status`: `healthy`, `degraded`, or `unhealthy`
* `data.services`: Map of service name to status (`up` / `down`)
* `data.uptime`: Process uptime in seconds
* `data.environment`: Deployment environment (e.g., `production`, `staging`)
* `data.response_time_ms`: Server-side computation time for the health route


## OpenAPI

````yaml GET /api/v1/health
openapi: 3.1.0
info:
  title: Handa Uncle API
  version: 1.0.0
  description: Public specification for the Handa Uncle web and mobile APIs.
  contact:
    name: Handa Uncle Engineering
    email: hello@handauncle.com
servers:
  - url: https://handauncle-backend-prod-205012263523.asia-south1.run.app
    description: Prod API base (Cloud Run)
  - url: https://api.handauncle.com
    description: Production
  - url: https://staging-api.handauncle.com
    description: Staging
  - url: http://localhost:8080
    description: Local development
security: []
tags:
  - name: Mobile App
    description: Endpoints used by the native Handa Uncle app.
  - name: Platform
    description: Cross-service operational endpoints.
  - name: Auth
    description: Authentication endpoints handled by the backend adapter.
  - name: AI
    description: LLM chat endpoints supporting streaming and device-auth guests.
  - name: OTP
    description: Phone OTP lifecycle powered by Exotel.
  - name: Webhooks
    description: Server-to-server hooks invoked by Auth0.
  - name: Conversations
    description: Authenticated user conversation management.
  - name: Chat Share
    description: Create, manage, and consume shared conversations.
  - name: Files
    description: Upload, list, and delete user files.
  - name: Prompt management
    description: Admin and public APIs for managing masked pre-prompts.
  - name: User Profile
    description: Profile card collection and user data for personalized AI responses.
  - name: Visual Embeds
    description: Manage visual embed images that attach to AI chat responses.
  - name: Second Opinion
    description: Admin and public APIs for Second Opinion suggestion cards.
  - name: Profile Cards
    description: >-
      APIs for managing profile card questions used in onboarding and
      personalization.
paths:
  /api/v1/health:
    get:
      tags:
        - Platform
      summary: Global platform health
      description: >-
        Aggregates MongoDB, Redis, and subsystem readiness and is used by load
        balancers for health checking.
      operationId: getPlatformHealth
      responses:
        '200':
          description: Health payload returned.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PlatformHealthResponseEnvelope'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
components:
  schemas:
    PlatformHealthResponseEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - true
        data:
          $ref: '#/components/schemas/PlatformHealthData'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - success
        - data
        - meta
    PlatformHealthData:
      type: object
      properties:
        status:
          type: string
          enum:
            - healthy
            - degraded
            - unhealthy
        timestamp:
          type: string
          format: date-time
        uptime:
          type: number
          description: Process uptime in seconds.
        services:
          $ref: '#/components/schemas/PlatformHealthServices'
        environment:
          type: string
        response_time_ms:
          type: integer
      required:
        - status
        - timestamp
        - uptime
        - services
        - environment
        - response_time_ms
    ResponseMeta:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
        requestId:
          type: string
          description: Server generated correlation identifier.
      required:
        - timestamp
        - requestId
    ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          $ref: '#/components/schemas/ErrorObject'
        meta:
          $ref: '#/components/schemas/ResponseMeta'
      required:
        - success
        - error
        - meta
    PlatformHealthServices:
      type: object
      additionalProperties:
        type: string
        enum:
          - up
          - down
    ErrorObject:
      type: object
      properties:
        message:
          type: string
          description: Human-readable error message describing the issue.
          example: Please enter a valid 10-digit phone number (e.g., 9876543210)
        code:
          type: string
          description: Error code for programmatic handling.
          example: VALIDATION_ERROR
        details:
          type: array
          description: >-
            Array of field-specific validation errors (for VALIDATION_ERROR
            responses).
          items:
            type: object
            properties:
              field:
                type: string
                description: Field name that failed validation.
                example: phone
              message:
                type: string
                description: Specific validation error message for this field.
                example: Please enter a valid 10-digit phone number (e.g., 9876543210)
            required:
              - field
              - message
      required:
        - message
  responses:
    ServiceUnavailable:
      description: Service is currently degraded or unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'

````