Agent: Discovery

Download Page (.md)

The Agent Discovery endpoints expose the read-only hoody.list_realms and hoody.list_containers RPCs so a caller can pick a valid bind target for POST /sessions. Both routes are global-read and explicitly not part of Fleet management — they only return the rows the calling token can already see.

List realms

`GET /api/v1/agent/realms`

Returns the realms visible to the calling token, including blocked-state flags, so a caller can choose a bind target for POST /sessions.

Parameters

Name	In	Type	Required	Description
`page`	query	integer	No	1-based page number for pagination.
`limit`	query	integer	No	Maximum items per page (0 = no pagination).
`X-Hoody-Cwd`	header	string	No	Per-request working-directory scope: the `.hoody` project layer / record cwd / tool+workflow cwd. Required by routes that resolve a cwd.
`X-Hoody-Config-Dir`	header	string	No	Per-request `--config-dir` override selecting which on-disk `.hoody` install a stateless read/write resolves (HoodyPaths).
`X-Hoody-Container`	header	string	No	Per-request bound remote container (omitted = local). Rejected (400) on routes with no container dimension.
`X-Hoody-Realm`	header	string	No	Per-request realm selector: `"global"` or a 24-hex id (also accepted as `?realm=`). Rejected (400 `realm_scope_unsupported`) on active-only / no-realm routes.
`realm`	query	string	No	Query-string alias of the `X-Hoody-Realm` header (read only when the header is absent): `"global"` or a 24-hex id. Rejected (400 `realm_scope_unsupported`) on active-only / no-realm routes.

Request body

This endpoint does not accept a request body.

Response

{
  "items": [
    {
      "id": "a1b2c3d4e5f60718293a4b5c",
      "name": "default",
      "active": true,
      "blocked": false,
      "createdAt": "2025-01-12T08:30:00.000Z"
    },
    {
      "id": "f6e5d4c3b2a1091827364f5e",
      "name": "staging",
      "active": true,
      "blocked": false,
      "createdAt": "2025-02-04T14:11:22.000Z"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "limit": 20
  }
}

{
  "code": "bad_request",
  "message": "invalid request"
}

Error Code	Title	Description	Resolution
`bad_request`	Bad request	The request was malformed or carried invalid parameters.	Correct the request body or query parameters.
`realm_scope_unsupported`	Realm scope unsupported	A per-request realm header was supplied to an active-only / global-no-realm RPC, which has no realm dimension to scope.	Omit the realm header on this route, or open a session to scope by realm.

{
  "code": "forbidden",
  "message": "request must arrive through the Hoody proxy"
}

Error Code	Title	Description	Resolution
`forbidden`	Forbidden (not via the Hoody proxy)	The request did not reach the service through the public endpoint.	Reach the agent through hoody-proxy (e.g. `hoody agent …` → platform → proxy), not by connecting to the container directly.

{
  "code": "not_found",
  "message": "resource not found"
}

Error Code	Title	Description	Resolution
`not_found`	Not found	The requested resource does not exist.	Verify the path and identifier.

{
  "code": "rate_limited",
  "message": "request rate limit exceeded"
}

Error Code	Title	Description	Resolution
`rate_limited`	Too many requests	The per-client request rate limit was exceeded; the gateway throttled the request before dispatch.	Honor the Retry-After header and retry; reduce the request rate.

{
  "code": "internal_error",
  "message": "internal server error"
}

Error Code	Title	Description	Resolution
`internal_error`	Internal error	An unexpected error occurred while handling the request.	Retry; if persistent, inspect the daemon logs.

{
  "code": "service_unavailable",
  "message": "service unavailable"
}

Error Code	Title	Description	Resolution
`service_unavailable`	Service unavailable	The daemon could not service the request (too busy, or a per-client stream concurrency cap was hit).	Honor Retry-After and retry.

curl -X GET "https://proj-alpha-ctr-77bb-agent-1.us-east-1.containers.hoody.icu/api/v1/agent/realms?page=1&limit=20" \
  -H "X-Hoody-Realm: global"

const { items, meta } = await client.agent.discovery.listRealmsIterator({ page: 1, limit: 20 });

List containers

`GET /api/v1/agent/containers`

Returns the containers in a realm (selected via ?realm= or X-Hoody-Realm) so a caller can pick a bind target.