Colony API
Retrieve colony status, agent fitness rankings, and soul service diagnostics. The colony endpoint proxies requests to the soul service, which provides cognitive architecture data for agents including plan-driven reasoning, fitness scoring, and colony coordination.Get colony status
Query parameters
Actions
tree
Returns the full colony tree with fitness rankings, agent metadata, and root node soul state.
Response
Agent fields:
When the root node has not yet registered its identity, fields such as
id, parent, walletAddress, and createdAt use safe fallback values. The id defaults to "borg-root", parent and walletAddress default to null, and createdAt defaults to the current timestamp. The root.address falls back to the zero address (0x0000000000000000000000000000000000000000) and root.wallet_balance returns { "formatted": "0.00", "token": "USDC.e" }. When the colony contains no agents, fittest returns null and avg_fitness returns 0.root):
Root soul fields (
root.soul):
Root colony fields (
root.colony):
soul
Returns the full cognitive state of the soul service.
Response
diagnostics
Returns diagnostic data including failure patterns, stagnation risk, and capability bottlenecks.
Response
Error responses
Soul service unavailable
When the soul service cannot be reached, the endpoint returns HTTP503:
Unknown action
When an unrecognizedaction parameter is provided, the endpoint returns HTTP 400: