00 DOCS_INDEX OLYX-DOC-0000 / v1
v1 / CLOSED BETA SDK-FIRST · TRACEABLE · MODEL-ROUTED

The control plane
for LLM traffic.

Olyx gives beta teams one governed path for model calls: create a trace, execute through the SDK, complete the workflow, then inspect cost, latency, and routing behavior.

TypeScript · Python · Ruby · OpenAI-compatible migration path · optional private agent routes.

01 WHY_OLYX three_pillars
01.01 CONTROL

Route model traffic through project policy instead of duplicating provider logic across call sites.

01.02 OBSERVE

Record traces for model calls, tool steps, latency, cost, and routing decisions that developers can inspect.

01.03 OPTIMIZE

Use completed traces and replays to compare models before changing production routing.

02 QUICKSTART closed_beta / sdk_path

From zero to first traced request.

Start with a project-scoped API key and an SDK call. If you are migrating an existing app, the OpenAI-compatible gateway is the quickest swap; the SDK pages cover the full trace-first workflow.

flowchart LR PROJECT[CREATE PROJECT] KEY[CREATE API KEY] SDK[CONFIGURE SDK] EXEC[EXECUTE IN TRACE] REVIEW[REVIEW TRACE] PROJECT --> KEY --> SDK --> EXEC --> REVIEW
  1. 01

    STEP / 01

    Create a project

    Projects isolate model registry settings, API keys, trace history, and beta configuration.

    Open dashboard
  2. 02

    STEP / 02

    Generate an API key

    Use one project-scoped key per service or environment so staging, production, and workers are easy to separate.

    API key docs
  3. 03

    STEP / 03

    Send an SDK request

    Create a trace, call `execute`, and complete the trace when the workflow is done.

    See SDK example
  4. 04

    STEP / 04

    Inspect and tune

    Use traces, cost intelligence, and replays to understand model behavior before changing routing.

    Trace docs
03 GATEWAY_MIGRATION openai_compatible / one_line

Keep the same client. Change only the base URL.

This is the fastest migration path for an existing app. You keep your current OpenAI-style client and point it at Olyx. The SDK pages below cover the governed trace-first path.

import OpenAI from "openai";

const client = new OpenAI({
  apiKey:  process.env.OLYX_API_KEY,
  baseURL: "https://olyx.ai/v1",
});

const response = await client.chat.completions.create({
  model: "gpt-4o",
  messages: [{ role: "user", content: "Translate to French: Hello, world." }],
});
import os
from openai import OpenAI

client = OpenAI(
    api_key=os.environ["OLYX_API_KEY"],
    base_url="https://olyx.ai/v1",
)

response = client.chat.completions.create(
    model="gpt-4o",
    messages=[{"role": "user", "content": "Translate to French: Hello, world."}],
)
require "openai"

client = OpenAI::Client.new(
  access_token: ENV["OLYX_API_KEY"],
  uri_base: "https://olyx.ai/v1",
)

response = client.chat(
  parameters: {
    model: "gpt-4o",
    messages: [{ role: "user", content: "Translate to French: Hello, world." }],
  }
)
04 FIRST_SDK_REQUEST typescript / python / ruby

These examples show the same shape across the supported SDKs. Use the language your service already runs.

import Olyx from "@olyx-labs/olyx";
const client = new Olyx({ apiKey: process.env.OLYX_API_KEY! });
const trace = await client.traces.create({
  metadata: { feature: "quickstart" },
});

const result = await client.execute({
  traceId: trace.data.id,
  input: "Translate to French: Hello world.",
});

await client.traces.complete(trace.data.id);
console.log(result.data.output);
import os
import olyx

client = olyx.Olyx(
    api_key=os.environ["OLYX_API_KEY"],
    mock=False,
)

trace = client.traces.create(metadata={"feature": "quickstart"})

result = client.execute(
    trace_id=trace.id,
    input="Translate to French: Hello world.",
)

client.traces.complete(trace.id)
print(result.output)
client = Olyx.new(api_key: ENV.fetch("OLYX_API_KEY"))
trace = client.traces.create(
  metadata: { feature: "quickstart" }
)

result = client.execute(
  trace_id: trace.id,
  input: "Translate to French: Hello world."
)

client.traces.complete(trace.id)
puts result.output
05 EXPLORE concepts / guides / reference

The working map.

06 AUTHENTICATION api_key / session
auth_model.txt REQUIRED

Backend services use API keys. Dashboard users use sessions. Keep model-calling traffic on project-scoped API keys and keep those keys out of browser code.

OLYX_API_KEY=ak_<key_id>.<secret>
PROJECT-SCOPED KEYS RECOMMENDED Authentication docs
OLYX-DOCS / v1 PUBLIC DOCS · CLOSED BETA STATUS · BETA ACCESS
Was this page helpful?