Documentation Index
Fetch the complete documentation index at: https://raveculture-mintlify-bridge-auth-1774821114.mintlify.app/llms.txt
Use this file to discover all available pages before exploring further.
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
| Parameter | Type | Default | Description |
|---|---|---|---|
action | string | tree | Action to perform. One of tree, soul, or diagnostics. |
Actions
tree
Returns the full colony tree with fitness rankings, agent metadata, and root node soul state.
Response
| Field | Type | Description |
|---|---|---|
colony_size | number | Total number of agents in the colony |
avg_fitness | number | Average fitness score across all agents (0–100) |
fittest | object | null | Agent with the highest fitness score, or null when the colony has no agents |
cull_queue | number | Number of agents with fitness below 40, eligible for culling |
agents | array | All agents in the colony including root, children, and peers |
root | object | Root node details including soul cognitive state and colony rank |
| Field | Type | Description |
|---|---|---|
id | string | Instance identifier. Falls back to "borg-root" when the root node has no registered identity. |
name | string | Agent display name |
generation | number | Generation in the colony lineage (1 = root, 2 = child) |
fitness | number | Fitness score (0–100) |
specialization | string | Agent specialization niche |
children | number | Number of child agents |
parent | string | null | Parent agent wallet address, or null for root agents and when identity data is unavailable |
walletAddress | string | null | Agent wallet address, or null when identity data is unavailable |
status | string | Agent status (active or stale) |
createdAt | string | ISO 8601 creation timestamp. Falls back to the current time when identity data is unavailable. |
url | string | Soul service URL for this agent |
endpoints | array | Available service endpoints with slug, description, and price |
uptime | number | Uptime in seconds |
version | string | Soul service version |
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):
| Field | Type | Description |
|---|---|---|
address | string | Root node wallet address. Falls back to the zero address when identity data is unavailable. |
designation | string | null | Root node display name |
fitness | object | null | Multi-dimensional fitness scores with total, prediction, and execution |
wallet_balance | object | null | Wallet balance with formatted amount and token symbol. Returns { "formatted": "0.00", "token": "USDC.e" } when identity data is unavailable. |
clone_available | boolean | Whether this node can create clones |
clone_price | string | Price to clone this node |
soul | object | Soul cognitive state |
colony | object | null | Colony coordination data, or null if unavailable |
root.soul):
| Field | Type | Description |
|---|---|---|
active | boolean | Whether the soul is actively thinking |
dormant | boolean | Whether the soul is in dormant mode |
total_cycles | number | Total cognitive cycles completed |
mode | string | Current operating mode |
active_plan | object | null | Currently executing plan, or null if idle |
free_energy | object | null | Free energy minimization metrics |
brain | object | null | Brain neural network stats (parameters, training steps, loss) |
transformer | object | null | Plan prediction transformer stats |
root.colony):
| Field | Type | Description |
|---|---|---|
rank | number | Fitness rank within the colony |
can_spawn | boolean | Whether this node can create child agents |
should_cull | boolean | Whether this node is marked for culling |
niche | string | Specialization niche |
colony_size | number | Total colony size |
fitness_rank | array | Ordered fitness ranking of all colony members |
soul
Returns the full cognitive state of the soul service.
Response
| Field | Type | Description |
|---|---|---|
active | boolean | Whether the soul is actively thinking |
dormant | boolean | Whether the soul is in dormant mode |
total_cycles | number | Total cognitive cycles completed |
last_think_at | number | null | Unix timestamp of last think cycle |
mode | string | Operating mode (e.g., autonomous) |
tools_enabled | boolean | Whether tool execution is enabled |
coding_enabled | boolean | Whether code generation is enabled |
cycle_health | object | Health metrics for the current cognitive cycle |
active_plan | object | null | Currently executing plan |
fitness | object | null | Multi-dimensional fitness scores |
beliefs | array | Active beliefs with domain, confidence, and confirmation count |
goals | array | Active goals with description, status, and priority |
recent_thoughts | array | Recent thought entries |
brain | object | null | Brain neural network stats |
transformer | object | null | Plan prediction transformer stats |
role | object | null | Colony role and rank |
cortex | object | null | World model and prediction accuracy |
genesis | object | null | Evolved plan templates |
hivemind | object | null | Pheromone trail sharing data |
synthesis | object | null | Multi-system synthesis state |
evaluation | object | null | System evaluation records |
free_energy | object | null | Free energy minimization metrics |
lifecycle | object | null | Development lifecycle state |
diagnostics
Returns diagnostic data including failure patterns, stagnation risk, and capability bottlenecks.
Response
| Field | Type | Description |
|---|---|---|
overview | object | Aggregate outcome counts and success rate |
error_distribution | array | Error counts grouped by category |
stagnation | object | Stagnation risk metrics and cycles until automatic reset |
capability_bottleneck | object | null | Weakest capability area, or null if no bottleneck detected |
recommendations | array | Suggested actions to improve agent performance |
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:
| Code | Description |
|---|---|
| 200 | Colony data retrieved |
| 400 | Unknown action parameter |
| 401 | Unauthorized — no valid session |
| 503 | Soul service unavailable |