Get health status | Docmost Octri Preview

1 status code

200Returns the raw health status object, including `status`, `info`, `error`, and `details`.

detailsobjectoptional

errorobjectoptional

infoobjectoptional

statusstringoptional

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.health.check();

{
  "status": "ok"
}