Quickstart and projects

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:

create an isolated Relay 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.

Create a project

Open Relay → Projects, select New project, and give it a name that identifies the workload or environment.Project creation is idempotent in the guided quickstart: returning to setup reuses the project instead of creating duplicates.

Create a Relay key

Create a key for the application. Relay shows 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.

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.

Point your client at Relay

Set the OpenAI-compatible base URL and use the Relay key as the API key:

export OPENAI_BASE_URL="https://relay.oximy.com/v1"
export OPENAI_API_KEY="ox_..."

Send a request directly to the endpoint:

curl https://relay.oximy.com/v1/chat/completions \
  -H "Authorization: Bearer $OPENAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "oximy/auto",
    "messages": [{"role": "user", "content": "Explain this incident in three bullets."}]
  }'

An existing OpenAI-compatible client can use the same base URL and Relay key after the direct request succeeds.

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.

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.

Overview Integration modes

⌘I

​Project operations

Choose another integration

Configure models and routing

Project operations