Hoody Notes

The Hoody Notes service provides collaborative notebooks, documents, and real-time editing capabilities. This page covers the public HTTP endpoints exposed by the Notes service.

Health

`GET /api/v1/notes/health`

Returns a standardized health payload for the Notes service. The response includes service identity, build and start timestamps, resource counters (memory and file descriptors), the process identifier, the peer IP address, and the caller’s user-agent string. Use this endpoint for liveness checks, monitoring dashboards, and on-call diagnostics.

This endpoint takes no parameters.

curl -X GET https://api.hoody.com/api/v1/notes/health \
  -H "Authorization: Bearer <token>"

const health = await client.notes.health.check();
console.log(health.status, health.service);

{
  "status": "ok",
  "service": "notes",
  "built": "2024-01-15T10:30:00Z",
  "started": "2024-01-20T14:22:17Z",
  "memory": {
    "rss": 52428800,
    "heap": 16777216
  },
  "fds": 128,
  "pid": 12345,
  "ip": "10.0.0.5",
  "userAgent": "Hoody-CLI/1.2.3"
}

Response fields

Name	Type	Required	Description
`status`	string	Yes	Health status. Currently always `"ok"` when the service is reachable.
`service`	string	Yes	Service identifier. Returns `"notes"` for this endpoint.
`built`	string \| null	Yes	Build timestamp of the running service binary (ISO 8601), or `null` if unavailable.
`started`	string	Yes	ISO 8601 timestamp marking when the service process started.
`memory`	object \| null	Yes	Resident memory counters: `rss` (bytes) and `heap` (bytes or `null`).
`fds`	number \| null	Yes	Number of open file descriptors, or `null` if unavailable on the host platform.
`pid`	number	Yes	Operating system process identifier for the running service.
`ip`	string	Yes	Peer IP address of the caller as observed by the service.
`userAgent`	string \| null	Yes	`User-Agent` header from the incoming request, or `null` if absent.

Status codes

Status	Meaning
`200`	Service is healthy and returned the diagnostic payload.