Quickstart - OmniMux

This guide covers: create an API key → set the Base URL → send a request.

Prerequisites

Access to the OmniMux console
Available quota (or a token provisioned by an admin)

Steps

Create an API key

Sign in to the console, open Tokens / API Keys, and create a key.Keys look like sk-.... Store them only on the server or in private environment variables — never in frontend code or public repos.

Set the Base URL

Gateway Base URL (API host):

https://api.omnimux.ai

For OpenAI-compatible SDKs, set:

https://api.omnimux.ai/v1

The SDK appends /chat/completions and other paths. The console lives at omnimux.ai/dashboard and is separate from the API host.

Send your first request

With curl:

curl https://api.omnimux.ai/v1/chat/completions \
  -H "Authorization: Bearer $OMNIMUX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-4o-mini",
    "messages": [
      {"role": "user", "content": "Hello — introduce yourself in one sentence"}
    ]
  }'

model must be enabled for your account. Check the console or call GET /v1/models. Language contract: Claude · Complete API Reference.

Official OpenAI SDKs

Python

from openai import OpenAI

client = OpenAI(
    api_key="sk-...",  # OmniMux token
    base_url="https://api.omnimux.ai/v1",
)

resp = client.chat.completions.create(
    model="gpt-4o-mini",
    messages=[{"role": "user", "content": "Hello"}],
)
print(resp.choices[0].message.content)

Node.js

import OpenAI from "openai";

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

const resp = await client.chat.completions.create({
  model: "gpt-4o-mini",
  messages: [{ role: "user", content: "Hello" }],
});
console.log(resp.choices[0].message.content);

Next steps

Topic	What you get
Connection and usage	Base URL, dual credentials, common errors
Security and keys	Key hygiene
Cost optimization	Points / precharge / 402
API manual · complete	Language contract entry (brand model enum)
Integration guide	Chat apps / dev tools / platforms
llms.txt · skill.md · Docs MCP	Agent-readable index, product skill, and docs search MCP

Handing this site to an agent? Start with llms.txt for the page index, or install the docs MCP from the page header menu (Connect to Cursor / VS Code). Full dump: llms-full.txt.

API keys can spend account quota. Keep them server-side only. Rotate immediately if exposed.

​Prerequisites

​Steps

​Official OpenAI SDKs

​Python

​Node.js

​Next steps

Prerequisites

Steps

Official OpenAI SDKs

Python

Node.js

Next steps