Custom AI Provider
A Custom AI provider connector routes requests to an LLM endpoint of your own, such as a model server that has no dedicated connector in HYPR AgentPass™. You set the host, the port and the routes the gateway forwards.
A Custom connector forwards its traffic whatever its onboarding mode. Its onboarding never holds a first request for approval, and never refuses one. It attributes callers to agents only in Observe only mode, so choose that mode.
Before You Begin
You need:
- The endpoint's host name and port
- The request paths your agents call, and the paths the endpoint expects
Create the Connector
- Open Connectors → Add connector → AI Providers → Custom. The Add Custom Connector form opens.
- Enter a Connector Name and a Display Name. They default to
customand Custom. - Under Backend Configuration, enter the Backend Host, such as
api.example.com. A scheme you type, such ashttps://, is removed. - Enter the Backend Port. It defaults to 443.
- Leave Enable TLS on, unless the endpoint does not use TLS.
- Under Routes, add a route for each kind of request the gateway forwards. See Routes.
- Click Next.
- Under How should new agents onboard?, select Observe only.
- Click Create Connector. The connector opens.
Routes
A route tells the gateway which requests to send to the endpoint, and at which path. Each route has these fields.
| Field | What it does |
|---|---|
| Method | POST, GET, PUT, DELETE, PATCH or ANY |
| Match | A regular expression tested against the incoming request path, such as /v1/chat/.*. Required |
| Forward to | Optional. A literal path that replaces the request path before the gateway forwards it. Leave it blank to forward the path unchanged |
| Description | Optional. A note shown in the connector's route list |
Click Add Route to add another route, or the remove icon beside a route to delete it.
These examples show the two ways a route forwards.
| Method and match | Forward to | Result |
|---|---|---|
POST /responses.* | /v1/responses | The gateway rewrites the path to /v1/responses |
POST /v1/chat/.* | Blank | The gateway forwards the path as it arrived |
Order matters. The gateway uses the first route that matches, so list more specific patterns before catch-alls.
Routes match at the gateway root. Agents send requests to the gateway's public origin, with the path the route matches, and no connector name in the path. A catch-all pattern such as /.* matches any path, so it can take requests meant for your other AI provider connectors. Keep Custom patterns specific.
How Callers Are Attributed
In Observe only mode, the gateway identifies each caller from its request headers, such as a credential that belongs to an agent AgentPass already knows, or the client's user agent. A caller it does not recognize stays unattributed. The gateway creates no agent for it.
A policy on this connector can use the request and connector attributes. Inference policy attributes are not set on Custom traffic. See Policy Attributes.
The Connector's Tabs
A Custom connector has the shared Overview, Policies, Connections and Recent Requests tabs. See Reading a Connector.
Its Overview tab has these fields.
| Field | Meaning |
|---|---|
| Name, Enabled | The connector's name. Enabled turns traffic on or off |
| Endpoint | The host and port the gateway forwards to. Click Change to edit it |
| Onboarding Mode | What happens to an agent's first request. Keep it on Observe only. See Onboarding Mode |
| Routes | Each route's Method, Path Pattern, Forward Path and Description. A blank forward path shows as as-is |
To change the routes, click Edit. The drawer's Backend section holds the host, port, TLS and timeout settings, and the Routes list with Add Route.
Related
- Connectors — the kinds of connector, and managing one
- Onboarding Mode — what each mode does on each connector
- Anthropic — the dedicated connector for Claude traffic