> For the complete documentation index, see [llms.txt](https://ai.ortusbooks.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ai.ortusbooks.com/advanced/reference/built-in-functions/aiagentregistry.md).

# aiAgentRegistry

Get the singleton global AIAgentRegistry instance for registering, resolving, and observing agents.

Get the singleton global `AIAgentRegistry` instance for registering, resolving, and observing agents.

## Syntax

```javascript
aiAgentRegistry()
```

## Parameters

None.

## Returns

`AIAgentRegistry` singleton instance.

## Key Format

Agents are keyed as:

* `agentName`
* `agentName@moduleName`

## Core Methods

| Method                           | Description                                      |
| -------------------------------- | ------------------------------------------------ |
| `register( agent, module = "" )` | Register an `AiAgent` instance                   |
| `get( key )`                     | Retrieve agent by key                            |
| `has( key )`                     | Check whether key exists                         |
| `unregister( key )`              | Remove agent by key                              |
| `unregisterByModule( module )`   | Remove all agents in a module namespace          |
| `resolveAgents( agents )`        | Resolve mixed key/instance arrays to `AiAgent[]` |
| `getAgentInfo( key )`            | Lightweight metadata: name, description, module  |
| `listAgents()`                   | Return all registered agents with metadata       |
| `getKeys()`                      | List all keys                                    |
| `clear()`                        | Remove all entries                               |

## Events Fired

| Event                         | When                          |
| ----------------------------- | ----------------------------- |
| `onAIAgentRegistryRegister`   | After successful registration |
| `onAIAgentRegistryUnregister` | After unregister              |

## Examples

### Register and fetch

```javascript
agent = aiAgent(
    name: "support-agent",
    description: "Handles customer support"
)

aiAgentRegistry().register( agent, "my-app" )

saved = aiAgentRegistry().get( "support-agent@my-app" )
```

### Resolve mixed arrays

```javascript
resolved = aiAgentRegistry().resolveAgents( [
    "support-agent@my-app",
    anotherAgent
] )
```

### List observability metadata

```javascript
info = aiAgentRegistry().listAgents()
println( jsonSerialize( info ) )
```

### Unregister by module

```javascript
aiAgentRegistry().unregisterByModule( "my-app" )
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://ai.ortusbooks.com/advanced/reference/built-in-functions/aiagentregistry.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
