Skip to main content
A Relay project is the boundary for keys, provider credentials, routing policy, traffic, reports, and limits. Use separate projects for applications or environments that need independent access or measurement. By the end of this guide, you will:
  • use the automatically created Default project or choose another project,
  • issue and safely store a Relay key,
  • verify a provider credential,
  • send one OpenAI-compatible routed request, and
  • confirm the routing decision in Traffic.
If you are handing implementation to an application or observability owner, send them Install Relay. It includes Live and Observe paths, stack-specific examples, and copyable AI prompts.
1

Choose a project

Relay creates a Default project when the workspace activates Relay. Use it for the first integration, or open Relay → Projects and create a separate project when the workload or environment needs independent keys, routing, limits, and reporting.Returning to Get Started reuses the selected project instead of creating duplicates.
2

Create a Relay key

In Relay → Get Started, Copy AI prompt creates a project-scoped key and places it directly in the clipboard prompt. For a manual integration, create a key from Relay → API Keys. Relay reveals the full ox_... value once; store it in your secret manager before closing the dialog.
Relay cannot reveal a key again. Revoke a lost key and create a replacement.
3

Connect a provider

Add the provider credential Relay should use to execute requests. Verify it before enabling automatic routing.Observe-only projects do not need a provider credential unless Relay will also execute shadow comparisons.
4

Point your client at Relay

Set the OpenAI-compatible base URL and use the Relay key as the API key:
Send a request directly to the endpoint:
An existing OpenAI-compatible client can use the same base URL and Relay key after the direct request succeeds.
5

Confirm the request

Open Relay → Traffic. Confirm the request source, status, requested and resolved models, cost, latency, and routing reason.

​
Project operations

Project settings act as defaults. Individual Relay keys can carry narrower request-rate, monthly-budget, expiry, or routing overrides. Archiving removes a project from normal active use without erasing its historical records. Unarchive it when the same boundary should become active again.

Install Live or Observe

Share stack-specific setup instructions and AI install prompts.

Choose another integration

Observe existing calls or request decisions without proxying provider traffic.

Configure models and routing

Move from the first request to a production routing policy.