---
head:
  - - meta
    - name: description
      content: 在 OneGateway 获取 API Key 与 API 地址，复制模型 ID，完成第一次模型调用，并查看额度、日志与用量。
---

# 快速开始

OneGateway 是统一的 AI 网关平台，通过统一的 API 端点调用不同供应商的模型，支持 OpenAI、Anthropic 等接口格式，并提供智能路由、语义缓存、多维计费和内容安全等治理能力。

本指南帮助你在几分钟内完成从获取凭证到发起第一次调用的全过程。

::: tip 首页的快速开始向导
登录后，首页会显示 **快速开始** 向导：成员按步骤创建 API Key、发起调用并查看日志；管理员按步骤接入供应商、创建用户并设置用户额度。本指南的步骤与成员向导一致，可对照阅读。
:::

## 1. 获取 API Key

登录 OneGateway 控制台，进入 [API Keys](/user/tokens) 页面，点击 **新建 API Key**：

- 填写名称即可创建，默认不限额度、不过期、可调用全部模型
- 需要限制时打开 **高级设置**，配置配额、过期时间、分组定价和可用模型

创建成功后复制完整密钥（`sk-` 前缀）。密钥默认脱敏展示，请妥善保存。页面顶部的 **API 地址** 是下一步要用的 Base URL，一并复制。

## 2. 调用第一个模型

先进入[可用模型](/user/models)，找到需要调用的模型，点击模型 ID 旁的复制图标。你能调用的模型由管理员配置，请求中必须使用模型 ID，而不是卡片上的显示名。

OneGateway 支持多种接口格式，下面以最常用的 OpenAI 格式为例。把示例中的地址、密钥和模型替换为你复制的 API 地址、API Key 和模型 ID：

::: code-group

```bash [cURL]
curl https://your-api-endpoint/v1/chat/completions \
  -H "Authorization: Bearer sk-xxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "your-model-id",
    "messages": [{ "role": "user", "content": "你好" }]
  }'
```

```python [Python]
from openai import OpenAI

client = OpenAI(
    base_url="https://your-api-endpoint/v1",
    api_key="sk-xxxxxxxx"
)

resp = client.chat.completions.create(
    model="your-model-id",
    messages=[{"role": "user", "content": "你好"}]
)
print(resp.choices[0].message.content)
```

```ts [TypeScript]
import OpenAI from 'openai'

const client = new OpenAI({
  baseURL: 'https://your-api-endpoint/v1',
  apiKey: 'sk-xxxxxxxx'
})

const resp = await client.chat.completions.create({
  model: 'your-model-id',
  messages: [{ role: 'user', content: '你好' }]
})
console.log(resp.choices[0].message.content)
```

:::

应用已在使用 Anthropic 等其他接口格式时，不必改成上面的写法，把请求地址替换为 OneGateway 的 API 地址即可。

调用没有成功时，先核对 API 地址是否完整、密钥是否复制完全，以及模型 ID 是否来自可用模型页面。

::: tip 在 Claude Code、Codex 中使用
想让 Claude Code、Codex 等工具通过 OneGateway 调用模型，参考[接入常用工具](/guide/tools)。
:::

## 3. 查看用量

每次调用会实时扣减额度；调用记录约两分钟后出现在日志中。你可以在：

- [API Keys](/user/tokens) 卡片查看每个密钥的剩余额度与使用率
- [日志](/user/usage)查看每次调用的模型、Token 用量和费用
- [个人看板与统计](/user/my-dashboard)查看额度情况与近期的费用、用量趋势

## 接下来

- 在[工作室](/user/playground)中直接与模型对话，或按[接入常用工具](/guide/tools)配置 Claude Code、Codex 等客户端
- 查阅[常见问题](/guide/faq)，了解接入、权限、额度与调用排障
- 阅读 [简介](/guide/introduction)，了解 OneGateway 的用途与文档结构
- 在 [API Keys](/user/tokens) 中配置可用模型与 IP 限制
- 使用 [语义缓存](/guide/semantic-cache) 降低重复请求的成本
- 管理员从 [供应商与模型](/admin/providers-and-models) 接入模型并配置分组定价，再到 [管理用户](/admin/users) 维护成员账号

## 角色速览

| 角色 | 你能做什么 |
| ---- | ---------- |
| 成员 | 创建和管理自己的 API Key、查看用量与日志、兑换码充值 |
| 管理员 | 管理本公司的供应商、模型、定价、分组定价、成员的 API Key、兑换码与配额设置 |