Getting Started

See also: Runtime Bootstrap and Access, Deploy and Operations, Configuration Reference

This page is the admin, user, and maintainer map for the gateway.

• Use it when the behavior spans more than one file.
• Use the owning page instead of chasing the same rule through several docs.
• Keep ADRs in the repo for decision history. They are not part of the public nav in this pass.

Running The Gateway

• First boot, local access, bootstrap admin, seeded API keys:
  • Runtime Bootstrap and Access
• Runtime shape, same-origin model, local versus deploy caveats:
  • Deploy and Operations
• YAML shape, auth modes, provider fields, and config limits:
  • Configuration Reference
• Identity lifecycle, team rules, and current admin access overlays:
  • Identity and Access
• Budgets, spend windows, alerts, and reporting:
  • Budgets and Spending

Maintaining The Platform

• Action-oriented recovery and upgrade work:
  • Admin Runbooks
• Cross-cutting request path across routing, logging, pricing, and spend:
  • Request Lifecycle and Failure Modes
• Provider API family support, OpenAI-compatible route quirks, and compatibility follow-up work:
  • Provider API Compatibility
• Admin UI capability map and live surface maturity:
  • Admin Control Plane
• Generated admin contract, checked-in artifacts, and drift rules:
  • Admin API Contract Workflow
• Migration authoring and backend parity:
  • Migration Authoring
• E2E harness scope and release-side checks:
  • End-to-End Contract Tests
  • Release Process

Sections

Setup

• Runtime Bootstrap and Access
• Deploy and Operations

Configuration

• Configuration Reference
• Model Routing and API Behavior
• Pricing Catalog and Accounting

Operations

• Budgets and Spending
• Observability and Request Logs
• Admin Runbooks

Access

• Identity and Access
• OIDC and SSO Status
• Admin Control Plane

Reference

• Request Lifecycle and Failure Modes
• Provider API Compatibility
• Data Relationships
• Admin API Contract Workflow
• Migration Authoring
• End-to-End Contract Tests
• Release Process

Common Questions

• Model shows up but fails:
  • Model Routing and API Behavior
  • Request Lifecycle and Failure Modes
• Request succeeds but is not charged:
  • Pricing Catalog and Accounting
  • Budgets and Spending
  • Request Lifecycle and Failure Modes
• Compose boot finishes but admin access is unclear:
  • Runtime Bootstrap and Access
  • Deploy and Operations
  • Admin Runbooks
• Live admin contract changed and the UI drifted:
  • Admin API Contract Workflow
  • End-to-End Contract Tests