Connecting your agent

Orb’s local UI has an info page for each API you document. Its copy button copies a markdown brief: base URLs, auth method, endpoints, and an example request. The brief contains no keys.

1. Open the info page

Start the UI server from the gateway checkout:

node ui/server.mjs

The pages are at http://127.0.0.1:8792/apis/<name> while that server runs. They are bound to loopback and are not on the gateway’s public address. The list is declared, not discovered: an API gets a page when it has an entry in data/api-docs.json.

2. Press the copy button

The brief lists the base URLs for the API’s lane, the scope it needs, the 401 and 403 behavior, its endpoints, an example request, and any notes. It points at the token file path but never includes the token itself.

3. Give the agent its key

Put the key in the agent’s own credential setup, not in a chat message. The brief is written for agents, so you do not need to explain the API yourself.

4. Ask it to fetch something simple

If the request succeeds, the agent is connected.