Hoody Notes

Hoody Notes provides collaborative notebooks, documents, and real-time editing capabilities within the Hoody platform. The Notes service runs as a container-scoped endpoint, meaning each container exposes its own Notes instance on a dedicated subdomain.

Use the Notes service to:

Create and manage collaborative documents and notebooks
Edit content in real time with multiple participants
Track document state and revisions

Access is checked when a write is saved. Content and member writes (REST calls, sync mutations, uploads) are checked again at the moment they are saved, not only when the request arrives. If you lose access before that moment — removed from the notebook, role set to none, a section made private, a page moved into a private channel, the notebook deleted — the write is refused and nothing is saved: 404 notebook_not_found when the notebook is gone, 403 notebook_no_access when your membership is, 403 forbidden or 404 not_found when your access to the page was removed or it was deleted. A sync mutation batch reports FORBIDDEN or NOT_FOUND per item. A write that was saved before you lost access stays saved; if the notebook is deleted right after your write was saved, you may still get 404 notebook_not_found (the write is removed with the notebook). Automatic side effects are checked the same way and skipped when access is gone (a version snapshot after a write, a comment-anchor update while reading comments); cancelling an upload is checked when its stored bytes are removed.

This page documents the health-check endpoint for the Notes service. Additional sub-pages cover document management, real-time editing, and collaboration features.

Health Check

Verify that the Notes service is running and inspect runtime metadata such as build timestamps, memory usage, and process information.

Health Check

`GET /api/v1/notes/health`

Returns a standardized health payload with service identity, build/start timestamps, resource counters (memory, fds), process id, peer address, and the caller user-agent.

This endpoint takes no parameters and accepts no request body.

curl -X GET \
  "https://{projectId}-{containerId}-notes-1.{server}.containers.hoody.com/api/v1/notes/health" \
  -H "Authorization: Bearer $HOODY_TOKEN"

import { HoodyClient } from 'hoody-sdk';

const client = new HoodyClient({ baseURL: 'https://{projectId}-{containerId}-notes-1.{server}.containers.hoody.com', token: process.env.HOODY_TOKEN });

const health = await client.notes.kit.getHealth();
console.log(health);

  {
    "status": "ok",
    "service": "hoody-notes",
    "built": "2025-01-15T10:30:00.000Z",
    "started": "2025-01-20T08:00:00.000Z",
    "memory": {
      "rss": 128452096,
      "heap": 62300160
    },
    "fds": 24,
    "pid": 1,
    "ip": "10.0.1.42",
    "userAgent": "hoody-sdk/1.4.2"
  }

Response Fields

Name	Type	Required	Description
`status`	string	Yes	Service health status. Enum: `ok`.
`service`	string	Yes	Name of the service.
`built`	string \| null	Yes	Build timestamp of the service image, or `null` if unavailable.
`started`	string	Yes	Timestamp when the service process started.
`memory`	object \| null	Yes	Memory usage counters. Contains `rss` (number) and `heap` (number \| null).
`fds`	number \| null	Yes	Number of open file descriptors, or `null` if unavailable.
`pid`	number	Yes	Process ID of the service.
`ip`	string	Yes	Peer IP address of the caller.
`userAgent`	string \| null	Yes	User-Agent header from the request, or `null` if not provided.