Customize the gateway docs page

Each environment of a gateway serves an API reference at https://gateway.faustine.ai/<workspace>/<gateway>/docs. It lists every operation the environment exposes, with a console to try calls, a Markdown copy of every page and an llms.txt. You set it up in the gateway's Docs tab, per environment.

Make the reference public or private

To choose who can read the reference:

In the portal, go to Agent Gateway and select your gateway.
Select the Docs tab.
Turn Public docs on or off. The change applies immediately.

While Public docs is on, anyone with the link can read the reference, the OpenAPI document and SKILL.md. While it is off, a reader has to send a gateway API key in the Authorization header, and the reference shows only the operations that key can call. The cards for branding, texts and operations appear only while Public docs is on.

The Your API reference card shows the address of the reference. Select Open the docs to open it.

Set the title, color and logo

To change how the reference looks:

In the Branding card, select Customize.
Fill in the fields.
Select Save changes.

Field	What it sets	Limit
Title	The name of the reference. Defaults to the gateway name.	80 characters
Tagline	One line under the title on the overview page.	160 characters
Accent colour	A hex color such as `#6C5CE7`.
Logo URL	An `http` or `https` URL. The logo replaces the Faustine mark in the top bar, and "Served by Faustine" moves to the footer.	500 characters
Footer text	Contact details or links on every page. Plain text. URLs and email addresses become links.	300 characters

The accent and the logo you set in Look & feel are the defaults for every gateway. A value set in Branding replaces them for this environment.

Write the overview texts

To change what the overview page says:

In the Texts card, select Customize.
Enter a Lead paragraph, the first paragraph of the overview. Leave it empty to keep the default text.
Enter a Getting-started note. It appears at the top of the quick start. Use it to say how to get a key or which operations to try first.
Select Save changes.

Each text can be up to 1000 characters. The reference keeps paragraphs and does not render HTML.

Hide operations from the reference

To leave an operation out of the reference:

In the Operations in the docs card, select Customize.
Turn off the switch of each operation to hide, or select Hide all or Show all.
Select Save changes.

A hidden operation leaves the pages, the sidebar, the search, the Markdown copies and llms.txt. It is still served. A credential whose scope includes it can call it, and it stays in the OpenAPI document and in SKILL.md. To stop serving an operation, see Choose which operations are exposed.

Next steps

Set the look and feel of your gateway: the name, logo and color shared by every gateway.
Use a custom domain: serve the reference from your own hostname.
Choose which operations are exposed: remove an operation from the gateway, not only from the reference.