> ## Documentation Index
> Fetch the complete documentation index at: https://docs.omnimux.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Public hosts only: console https://omnimux.ai/dashboard · API https://api.omnimux.ai · docs https://docs.omnimux.ai.
> Gateway auth is Authorization: Bearer sk-… on https://api.omnimux.ai/v1 (OpenAI-compatible Chat Completions and related paths).
> Discover pages from /llms.txt; full site dump /llms-full.txt; product skill /skill.md; docs search MCP /mcp. Prefer .md page URLs for Markdown.
> Default docs locale is en; zh mirrors the same relative paths. Do not invent model ids not present on live pricing or the complete API pages.

# 快速开始

> 5 分钟内用 OmniMux 发出第一条 Chat Completions 请求。

本指南带你完成：创建 API Key → 配置 Base URL → 发送请求。

## 前置条件

* 可访问 [OmniMux 控制台](https://omnimux.ai/dashboard)
* 账户有可用额度（或管理员已分配令牌）

## 步骤

<Steps>
  <Step title="创建 API Key">
    登录 [控制台](https://omnimux.ai/dashboard)，打开 **令牌 / API Keys**，创建新密钥。

    密钥形如 `sk-...`。只在服务端或私密环境变量中保存，不要写入前端或公开仓库。
  </Step>

  <Step title="确认 Base URL">
    网关 Base URL（API 专用域名）：

    ```text theme={null}
    https://api.omnimux.ai
    ```

    使用 OpenAI 兼容 SDK 时，一般填：

    ```text theme={null}
    https://api.omnimux.ai/v1
    ```

    SDK 会再拼 `/chat/completions` 等路径。控制台在 [omnimux.ai/dashboard](https://omnimux.ai/dashboard)，与 API 域名分开。
  </Step>

  <Step title="发送第一条请求">
    使用 curl：

    ```bash theme={null}
    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": "你好，用一句话介绍你自己"}
        ]
      }'
    ```

    `model` 必须是你账户可用的模型名。可在控制台查看，或调用 `GET /v1/models`。语言合同见 [Claude · 完整参数](/zh/api-reference/text-series/claude/complete)。
  </Step>
</Steps>

## 使用官方 OpenAI SDK

### Python

```python theme={null}
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

```javascript theme={null}
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);
```

## 下一步

| 主题                                                                                                                                    | 说明                           |
| ------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- |
| [连接与使用](/zh/faqs/connection-usage)                                                                                                    | Base URL、双凭证与常见错误            |
| [安全与密钥](/zh/faqs/security)                                                                                                            | Key 保管                       |
| [成本优化](/zh/faqs/cost-optimization)                                                                                                    | 积分 / 预扣 / 402                |
| [API 手册 · 完整参数](/zh/api-reference/text-series/claude/complete)                                                                        | 语言合同入口（品牌枚举 model）           |
| [集成指南](/zh/integration-guide/chatbox)                                                                                                 | 聊天应用 / 开发工具 / 应用平台           |
| [llms.txt](https://docs.omnimux.ai/llms.txt) · [skill.md](https://docs.omnimux.ai/skill.md) · [Docs MCP](https://docs.omnimux.ai/mcp) | Agent 可读索引、产品 Skill、文档搜索 MCP |

<Tip>
  要把文档交给 Agent？先读 [llms.txt](https://docs.omnimux.ai/llms.txt) 拿站点索引，或从页眉菜单安装文档 MCP（**Connect to Cursor / VS Code**）。全量正文：[llms-full.txt](https://docs.omnimux.ai/llms-full.txt)。
</Tip>

<Warning>
  API Key 可消费账户额度。仅放在服务端；泄露后立即在控制台吊销并轮换。
</Warning>