1. Home
  2. Documentation
  3. AI Gateway
  4. Routes

Routes

Expose HTTP endpoints that forward requests to an LLM Provider.

The Routes module defines the HTTP endpoints exposed by AI Gateway. These endpoints receive requests from your applications and forward them to an associated LLM Provider. Each route maps a public path to a registered provider and a specific HTTP method. You can optionally override the provider endpoint, configure a timeout, and require scopes in the access token.

NOTE

To create a route, you must have at least one registered LLM Provider. Policies are applied per route. A route without a policy processes requests without guardrails, rate limiting, or prompt enrichment.

Learn how to:

Listing

The Routes page lists registered routes with pagination. You can filter by:

  • LLM Provider (optional): identifies the LLM Provider associated with the route.
  • HTTP method (optional): route HTTP method. Values: All methods, GET, POST, PUT, PATCH, DELETE.
  • Exposed endpoint (optional): text search by exposed path.

Use Search to apply the filter and Clear to reset it.

Columns shown in the table:

  • Method: route HTTP method.
  • Exposed Endpoint: public path exposed by the gateway.
  • LLM Provider: summary of the linked LLM Provider, displayed as a list of tags with one entry per provider configuration, in the format Provider / Model / Pn (for example, OpenAI / gpt-4o / P1). Shows No LLM provider. when empty.
  • Timeout (s): timeout in seconds for the provider call (shows - when not configured).
  • Scopes: list of associated scopes, resolved to the name registered in Scopes. Shows No scopes assigned. when empty.
  • Created At: creation date and time in your time zone.
  • Actions: View and Delete icons for each row, each shown according to the user's permission โ€” see Permissions. The whole column is hidden when neither icon is available.

Create Route

Step 1

On the Routes page, click Create Route.

Step 2

Fill in the Create Route form fields (see Form fields). The LLM Provider field is a searchable select. Type part of the identifier to filter the list.

Step 3

Click Save to confirm the registration. To discard the operation, click Cancel.

View Route

In the Actions column of the row you want, click the View icon. This opens the read-only Route details screen, with the following fields:

  • Method
  • Exposed Endpoint
  • Timeout (s)
  • LLM Provider
  • Scopes
  • Created At

No field is editable on this screen. An empty field shows โ€”, with two exceptions that keep the dedicated text already used in the listing: LLM Provider shows No LLM provider configured. when the route has no configured provider, and LLM provider not found. when the referenced provider cannot be resolved; Scopes shows No scopes assigned. when the list is empty.

Edit Route

Editing lives inside the details screen. Open the route through the View icon (see View Route) and, on Route details, click the Edit button at the top of the section. The Update Route form opens with the current data. Change the required fields and click Save.

Delete Route

In the Actions column of the row you want, click the Delete icon. Confirm the operation in the "Do you want to delete route [routeId]?" dialog.

IMPORTANT

Deletion is permanent and cannot be undone. Policies associated with the route also become orphaned. Review and remove dependent policies before deleting the route.

Form fields

The table below covers all fields in the creation and edit forms.

Field
Type
Required
Rules
LLM ProviderSearchable selectYesLists registered LLM Providers.
HTTP methodSelect (enum)YesValues: GET, POST, PUT, PATCH, DELETE.
Exposed endpointTextYesMinimum 1 character. Public path exposed by the gateway (for example, /v1/chat/completions).
Provider endpointTextNoWhen provided, overrides the default endpoint of the associated provider. Minimum 1 character.
Provider timeout (seconds)IntegerNoWhen provided, must be a positive integer.
ScopesMulti-selectNoList of scope IDs from the Scopes catalog required in the request access token. Select zero or more scopes. An empty list means any authenticated token can access the route.
TIP

An empty Scopes list means any authenticated token can access the route. To restrict access, register the relevant scopes in Scopes, select one or more here, and make sure the presented token contains those scope IDs.

Permissions

Access to each action in the Routes journey depends on its own permission. Without the corresponding permission, the screen element does not appear โ€” the interface never shows an unavailable action as disabled.

Permissions are granted in Access Control, on the Roles screen, under the AI Gateway product. The table below lists each one exactly as Access Control displays it.

Permission
Group in AC
Description in AC
Identifier
List RoutesroutesAllows listing Routesai-gateway.routes.list
View RouteroutesAllows viewing a Routeai-gateway.routes.view
Create and Update RoutesroutesAllows creating and editing Routesai-gateway.routes.create-update
Delete RoutesroutesAllows deleting Routesai-gateway.routes.delete
List LLM Providersllm-providersAllows listing LLM Providersai-gateway.llm-providers.list

The last one belongs to another journey and is required by specific Routes actions, shown in the next table.

Action
What it unlocks
Required permissions
ListRoutes item in the sidebar menu; listing with table and paginationList Routes
Filter by LLM ProviderLLM Provider filter field on the listingList Routes + List LLM Providers
ViewView icon on the row and the Route details screenList Routes + View Route
CreateCreate Route buttonList Routes + Create and Update Routes + List LLM Providers
EditEdit button inside Route detailsList Routes + View Route + Create and Update Routes + List LLM Providers
DeleteDelete icon on the rowList Routes + Delete Routes

Create and Edit: List LLM Providers is what feeds the form's LLM Provider field, required in both.

Filter: without List LLM Providers, the LLM Provider filter is hidden; the other filters, the table and pagination remain available.

A control without its permission is not rendered; a route reached directly by URL without its permission lands on the AI Gateway's own access denied screen, not on Access Control's.

EDITING REQUIRES VIEWING

The Edit button only exists inside the Route details screen. Because of that, a user holding Create and Update Routes but not View Route has no path to edit an existing route. This is expected platform behavior, not a bug.

How happy are you with this page?

We use cookies to enhance your experience on our site. By continuing to browse, you agree to our use of cookies.Learn more