Prerequisites
Before starting with Tetrate Agent Router, verify that you have the following access and environment requirements in place. This page covers what each role needs (developers and administrators) to use Agent Router successfully from day one.
Management Plane
The very first prerequisite for installing, configuring or using a self-hosted data plane, is a provisioned Management Plane. Both the provisioning and operational management is done by Tetrate, making the management plane a hosted components. At the moment, it is not possible to fully self-host Agent Router Enterprise, only the data plane.
For more information on hosting options and the underlying architecture, consult Planes and core components.
Account access
Tetrate Agent Router serves different web applications, each serving a distinct role. Depending on your function, you may need access to one or both.
| Requirement | Details |
|---|---|
| User account | An email/password or SSO credential provided by your administrator. For Proof-of-Concept (PoC) environments, Tetrate provisions accounts with appropriate roles. |
| Console URL | The developer-facing application for API keys, model routing, and usage monitoring (e.g., https://router.poc.tetrate.ai/) |
| Admin Dashboard URL | The operator-facing application for managing models, providers, and users (e.g., https://dashboard.poc.tetrate.ai/) |
Your administrator will provide URLs and initial credentials during onboarding. If your organization uses SSO, you will authenticate through your corporate identity provider; no separate password is required. Agent Router access is role-based: each user is granted access only to the applications appropriate to their function.
Browser requirements
Tetrate Agent Router is fully browser-based; no desktop software installation is required. Both applications support the following browsers:
- Google Chrome 90+
- Mozilla Firefox 90+
- Microsoft Edge 90+
- Safari 15+
JavaScript must be enabled. A screen resolution of 1280×720 or higher is recommended for the best experience, particularly when viewing usage dashboards and request log details.
For developers (Console users)
Developers use the Console to create API keys, browse the model catalog, configure routing policies, and monitor usage. In addition to account access, you will need:
| Requirement | Purpose |
|---|---|
| API key | Generated in the Console under API Keys. Authenticates all AI requests sent through the gateway and determines which routing policies apply. |
| Proxy endpoint URL | The address your application sends requests to instead of calling AI providers directly. The gateway handles routing, fallback, guardrail enforcement, and provider translation transparently. Shown on your Dashboard (e.g., https://proxy.poc.tetrate.ai/v1). |
| SDK or HTTP client | Any OpenAI-compatible client library or HTTP tool. No gateway-specific SDK is required. |
Supported SDKs and tools
Tetrate Agent Router is compatible with any tool or library that speaks the OpenAI API format. To connect, replace the provider's base URL with your proxy endpoint URL and use your Console API key. No other changes are required.
| Category | Examples |
|---|---|
| Python libraries | openai, langchain, crewai, pydantic-ai, llama-index |
| TypeScript/JavaScript | openai SDK, Vercel AI SDK |
| Code assistants | Cline, Aider, Continue, Roo Code, Goose |
| Chat interfaces | Open WebUI |
| MCP clients | Claude Code, Cursor, VS Code |
For step-by-step setup instructions for each tool, see Integrations.
For administrators (Admin Dashboard users)
Administrators use the Admin Dashboard to manage model availability, configure AI provider credentials, control user access, and maintain Agent Router audit trail. You need:
| Requirement | Purpose |
|---|---|
| Admin role | Assigned by a Agent Router administrator. Grants access to the Admin Dashboard and all operator-level controls. |
| Provider credentials | API keys for each AI provider you plan to configure (e.g., OpenAI, Anthropic, Azure OpenAI, Google Vertex AI). These are stored securely by Agent Router and are never exposed to Console users. |
| SSO metadata | SAML metadata or OIDC discovery URL from your corporate identity provider, if setting up enterprise single sign-on. |
In PoC environments, provider credentials and initial Agent Router configuration are preconfigured by Tetrate. Administrators can review and modify these settings from first sign-in.
Network requirements
If your organization uses network firewalls or outbound proxies, ensure the following outbound HTTPS connections are permitted from client machines:
| Destination | Port | Purpose |
|---|---|---|
| Console URL | 443 | Web application access |
| Admin Dashboard URL | 443 | Web application access |
| AI Gateway proxy endpoint | 443 | Application API request routing |
For Agent Router Enterprise Self-Hosted Data Plane deployments, you install the data plane (Controller + Agent Router) in your cluster. Tetrate hosts the management plane. The data plane requires a single outbound HTTPS connection from your Kubernetes cluster to the management plane for configuration polling. No inbound connections from the internet to the data plane are required. See Deployment models and Architecture Overview for full topology details.
Kubernetes requirements
Self-hosted data plane installs require a Kubernetes cluster running Kubernetes 1.32 or later.
SSO requirements
Single sign-on (SSO) lets users access the Console and Admin Dashboard through your corporate identity provider. Any OIDC-compliant identity provider is supported.
Before configuring SSO, collect the following details:
- Issuer (Identity Provider URL)
- Client ID
- Client Secret
- Discovery URL (optional)
When SSO is required depends on your deployment path. Open your path from the Get started sidebar, or see Deployment models if you are unsure which applies.
- Agent Router Service: SSO is handled by Tetrate; no customer SSO setup.
- Enterprise Fully Managed: Configure SSO during onboarding (wizard Step 2) or confirm it is already set up in a PoC environment.
- Enterprise Self-Hosted Data Plane: Gather SSO details early, but you can configure SSO after the data plane and gateway are running — before opening the Console to developers.
In Tetrate-provisioned PoC environments, SSO may already be configured; confirm with your administrator before starting the onboarding wizard. Mapping IdP roles to Agent Router roles is optional and can be done after the data plane is running.
Evaluation checkpoint
Use this checklist to confirm your environment is ready before proceeding to the quickstarts:
- you have completed Management plane onboarding (triggered when first opening the Admin Dashboard)
- You can access the Console URL and sign in successfully
- You can access the Admin Dashboard URL (if applicable to your role)
- Your browser meets the minimum version requirements
- For self-hosted data plane installs: your cluster meets the Kubernetes version requirement
- You have an API key (or can create one in the Console)
- You know your proxy endpoint URL
Where to go next