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

# 快速开始

> 将 VibeToken API 集成到你的产品所需的一切。

欢迎使用 **VibeToken**。本指南涵盖你通过单一统一 API 调用 AI 模型（视频、图像和聊天）所需的一切。

## 1. 可用模型与 Playground

在我们的 Market 页面查看最新支持的模型：

👉 [vibetoken.cn/market](https://vibetoken.cn/market)

* 随着新模型趋于稳定，我们会持续添加。
* 每个模型页面都链接到其 **Playground**，你可以在其中测试参数并查看输出，无需编写任何一行代码。
* Playground 是理解模型所需输入与产出结果的最快方式。

## 2. 定价

完整且最新的定价列表可在此处查看：

👉 [vibetoken.cn/pricing](https://vibetoken.cn/pricing)

* Market 上每个模型页面都会在上游官方费率旁展示单次调用价格，让你清楚看到节省了多少。
* 随着上游供应商调整成本，定价可能会变化——请始终查看定价页面以获取最新信息。

## 3. 创建并保护你的 API Key

在此处创建和管理你的 API Key：

👉 [vibetoken.cn/api-key](https://vibetoken.cn/api-key)

<Warning>
  **切勿在前端代码中暴露你的 API Key**——无论是浏览器、移动应用还是公开仓库。请将其视为机密。
</Warning>

每个 API Key 都支持：

* **速率限制**——按小时、按天以及总额度上限
* **IP 白名单**——仅限已批准的服务器 IP 访问

## 4. 必需的请求头

每个 API 请求都必须包含：

```http theme={null}
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json
```

缺失或错误的请求头会返回：

```json theme={null}
{ "code": 401, "msg": "You do not have access permissions" }
```

## 5. OpenAI 兼容 API

VibeToken 提供标准的 OpenAI API 接口，因此你可以无需改动地复用 OpenAI SDK——只需将其指向 `https://vibetoken.cn/v1`：

| Endpoint                                               | Modality        |
| ------------------------------------------------------ | --------------- |
| `POST /v1/chat/completions`                            | 聊天 / LLM（同步、流式） |
| `POST /v1/images/generations`                          | 图像（同步）          |
| `POST /v1/videos/generations`                          | 视频（异步）          |
| `POST /v1/audio/speech` · `POST /v1/audio/generations` | 音频（异步）          |

```python theme={null}
from openai import OpenAI
client = OpenAI(api_key="sk-rb-...", base_url="https://vibetoken.cn/v1")
client.chat.completions.create(model="google/gemini-2.5-flash", messages=[...])
```

## 6. 同步 vs 异步

聊天和图像是**同步的**——响应中直接包含结果。

视频和音频是**异步的**：`POST` 返回 `{id, status:"pending"}`，随后你可以轮询 `GET /v1/videos/generations/{id}`，或提供 `callback_url`。完整流程参见 [异步任务](/essentials/async-tasks)。

## 7. 日志与任务详情

在此处查看所有历史任务：

👉 [vibetoken.cn/logs](https://vibetoken.cn/logs)

每条日志记录都会显示创建时间、所用模型、输入参数、任务状态、消耗的额度，以及最终结果或错误详情。

## 8. 数据保留

| Data             | Retention |
| ---------------- | --------- |
| 生成的媒体文件（视频 / 图像） | 14 天      |
| 日志记录             | 2 个月      |

请在过期前将结果下载并保存到你自己一侧。

## 9. 速率限制

默认情况下：

* 每个 API Key **每 10 秒最多 20 个新请求**
* 支持 **100+ 并发**运行任务
* 超出限制会返回 HTTP **429**

按 Key 的配置详情参见 [速率限制](/essentials/rate-limits)。

## 10. 支持

通过仪表盘**左下角菜单**联系我们：

* Discord（最快）
* Telegram
* 邮箱：[support@vibetoken.cn](mailto:support@vibetoken.cn)

**支持时间：** UTC 21:00 – UTC 17:00（次日）