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)

GET /health

JavaScript

JavaScript

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);

200

{
  "status": "<string>",
  "services": [
    {
      "name": "<string>",
      "status": "<string>",
      "message": "<string>",
      "response_time_ms": 123
    }
  ],
  "timestamp": "<string>"
}

Response

200 - application/json

Successful Response

Response for detailed health check endpoint

status · string · required

services · ServiceStatus · object[] · required

Show child attributes

timestamp · string · required