Hoody Notes

The Hoody Notes service powers collaborative notebooks, documents, and real-time editing inside your containers. It exposes endpoints for managing notebook content, syncing collaborative sessions, and inspecting runtime health.

This page is the entry point for the Notes API reference. It lists the available sub-pages and documents the service-wide health check.

Health

Inspect the runtime status, build metadata, and resource counters of the Notes service.

View endpoint

Health

GET /api/v1/notes/health

Returns a standardized health payload describing the current Notes service instance: its identity (service), build and start timestamps, memory and file-descriptor counters, process id, peer IP, and the user agent of the caller. Use this endpoint to verify that a container’s Notes service is reachable and operational.

This endpoint takes no parameters.

cURL

curl -X GET "https://{projectId}-{containerId}-notes-1.{server}.containers.hoody.com/api/v1/notes/health"

TypeScript SDK

import { HoodyClient } from 'hoody-sdk';

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

await client.notes.health.check();

Response

{
  "status": "ok",
  "service": "notes",
  "built": "2024-01-10T08:15:32.000Z",
  "started": "2024-01-15T10:30:00.000Z",
  "memory": {
    "rss": 52428800,
    "heap": 16777216
  },
  "fds": 42,
  "pid": 1234,
  "ip": "10.0.0.5",
  "userAgent": "hoody-sdk/1.0"
}

Response fields

Field	Type	Required	Description
status	string	Yes	Health status of the service. Always "ok" when the endpoint responds.
service	string	Yes	Logical name of the service responding (for example, "notes").
built	string or null	Yes	Build timestamp of the running binary, or null when unavailable.
started	string	Yes	ISO-8601 timestamp at which the service process started.
memory	object or null	Yes	Process memory usage. Contains rss (resident set size, in bytes) and heap (heap usage in bytes, or null).
fds	number or null	Yes	Number of open file descriptors held by the process, or null when unavailable.
pid	number	Yes	Operating system process id of the service.
ip	string	Yes	IP address of the caller as observed by the service.
userAgent	string or null	Yes	User-Agent header of the caller, or null when not provided.