Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Health

The health endpoint is unauthenticated and is suitable for uptime checks, load balancer probes, and verifying the server started correctly.

Endpoint

GET /api/v1/health
curl http://localhost:3001/api/v1/health

Response

{
  "status": "ok",
  "backend": {
    "connected": true,
    "message": null
  }
}

Fields

FieldTypeDescription
statusstringAlways "ok" when the server is running.
backend.connectedbooleantrue if AiMessage has successfully opened chat.db. false indicates a permissions problem — check Full Disk Access.
backend.messagestring or nullOptional diagnostic message. Non-null when there is a backend error or warning to report.

Diagnosing issues

If connected is false, the most common cause is missing Full Disk Access for the app bundle. See Permissions.