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

# Health Check

> Comprehensive health check endpoint that queries all underlying services.

Checks the following services:
- PostgreSQL database
- Redis
- PGVector store
- Storage service (Local/S3)
- ColPali vector store (if enabled)



## OpenAPI

````yaml https://app.stainless.com/api/spec/documented/morphik/openapi.documented.yml get /health
openapi: 3.1.0
info:
  title: FastAPI
  version: 0.1.0
servers: []
security: []
paths:
  /health:
    get:
      tags:
        - health
      summary: Health Check
      description: >-
        Comprehensive health check endpoint that queries all underlying
        services.


        Checks the following services:

        - PostgreSQL database

        - Redis

        - PGVector store

        - Storage service (Local/S3)

        - ColPali vector store (if enabled)
      operationId: health_check_health_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DetailedHealthCheckResponse'
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Morphik from 'morphik';

            const client = new Morphik({
              apiKey: process.env['MORPHIK_API_KEY'], // This is the default and can be omitted
            });

            const response = await client.ping.status();

            console.log(response.services);
        - lang: cURL
          source: |-
            curl https://api.morphik.ai/health \
                -H "Authorization: Bearer $MORPHIK_API_KEY"
components:
  schemas:
    DetailedHealthCheckResponse:
      properties:
        status:
          type: string
          title: Status
        services:
          items:
            $ref: '#/components/schemas/ServiceStatus'
          type: array
          title: Services
        timestamp:
          type: string
          title: Timestamp
      type: object
      required:
        - status
        - services
        - timestamp
      title: DetailedHealthCheckResponse
      description: Response for detailed health check endpoint
    ServiceStatus:
      properties:
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
        response_time_ms:
          anyOf:
            - type: number
            - type: 'null'
          title: Response Time Ms
      type: object
      required:
        - name
        - status
      title: ServiceStatus
      description: Status of an individual service

````