> 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/aigatewayregistry.md).

# aiGatewayRegistry

Returns the singleton GatewayRegistry — the extension point external gateway modules use to make their gateway resolvable by aiGateway().

Returns the singleton `GatewayRegistry` — the extension point external gateway modules use to make their gateway resolvable by `aiGateway()`.

## Syntax

```javascript
aiGatewayRegistry()
```

## Parameters

No parameters.

## Returns

The singleton `GatewayRegistry` instance. The same instance is returned on every call within a runtime.

## Methods

| Method                         | Returns           | Description                                     |
| ------------------------------ | ----------------- | ----------------------------------------------- |
| `register( gateway, module )`  | `GatewayRegistry` | Register a gateway; `module` namespaces the key |
| `unregister( key )`            | `GatewayRegistry` | Remove one gateway by key                       |
| `unregisterByModule( module )` | `GatewayRegistry` | Remove every gateway a module registered        |
| `has( key )`                   | `boolean`         | Whether a key is registered                     |
| `get( key )`                   | `IGateway`        | Fetch a registered gateway                      |
| `listGateways()`               | `struct`          | Every registered gateway, keyed                 |

Keys follow the `name` or `name@module` convention, so two modules can each provide a gateway of the same name without colliding.

## Throws

`InvalidArgument` if the registered object is not an `IGateway`.

## Examples

### Registering From a Module

```javascript
// In your gateway module's ModuleConfig onLoad()
function onLoad() {
    aiGatewayRegistry().register( new MyPlatformGateway(), "bx-ai-gateway-myplatform" )
}

function onUnload() {
    aiGatewayRegistry().unregisterByModule( "bx-ai-gateway-myplatform" )
}
```

Once registered, the gateway resolves by name:

```javascript
gateway = aiGateway( "myplatform" )
```

### Inspecting the Registry

```javascript
if ( aiGatewayRegistry().has( "myplatform" ) ) {
    gateway = aiGatewayRegistry().get( "myplatform" )
}

// Fully-qualified key
gateway = aiGatewayRegistry().get( "myplatform@bx-ai-gateway-myplatform" )

// Everything currently registered
registered = aiGatewayRegistry().listGateways()
```

## Events

| Event                         | Payload                    |
| ----------------------------- | -------------------------- |
| `onGatewayRegistryRegister`   | `gateway`, `key`, `module` |
| `onGatewayRegistryUnregister` | `key`, `module`            |

## Related

* [Gateways](/main-components/gateways.md)
* [aiGateway()](/advanced/reference/built-in-functions/aigateway.md)


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

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

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.