---
url: https://limapi.com/docs/guide.md
---
# 概述与快速接入

> **OpenAI 兼容端点**：`https://limapi.com/api/v1`
>
> **Anthropic 兼容端点**：`https://limapi.com/api/anthropic`
>
> **认证方式**：Bearer Token（API Key）
>
> ```
> Authorization: Bearer sk-xxx
> ```
>
> 兼容 OpenAI / Anthropic 接口格式，可直接使用 OpenAI SDK 或 Anthropic SDK 接入。

## 三步开始使用

### 1. 获取 API Key

登录 [Portal 控制台](https://limapi.com/)，进入「API Keys」页面创建密钥。密钥以 `sk-` 开头，请妥善保管，不要泄露到客户端代码或公开仓库。

### 2. 确认接入端点

| 协议 / 用途 | 端点 |
|------|------|
| 协议一：OpenAI Chat Completions | `POST /api/v1/chat/completions` |
| 协议二：OpenAI Responses | `POST /api/v1/responses` |
| 协议三：Anthropic Messages | `POST /api/anthropic/v1/messages` |
| 模型列表 | `GET /api/v1/models` |
| Embeddings 向量化 | `POST /api/v1/embeddings` |
| 图片生成 | `POST /api/v1/images/generations` |
| 视频生成 | `POST /api/v1/videos` |
| 视频生成（Seedance） | `POST /api/v1/seedance/videos` |
| 语音合成 TTS | `POST /api/v1/audio/speech` |
| 实时语音合成（WebSocket） | `wss://limapi.com/api/v1/realtime/audio/speech` |
| 语音识别 ASR | `POST /api/v1/audio/transcriptions` |
| Rerank 重排序 | `POST /api/v1/rerank` |
| Decision 决策模型 | `POST /api/v1/decisions` |

使用 OpenAI SDK 时，`baseURL` 设为 `https://limapi.com/api/v1`；
使用 Anthropic SDK 或 Claude Code 时，`base_url` 设为 `https://limapi.com/api/anthropic`。

### 3. 发起第一个请求

```bash
curl https://limapi.com/api/v1/chat/completions \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer sk-xxx" \
  -d '{
    "model": "qwen3.8-max",
    "messages": [
      {"role": "user", "content": "你好，介绍一下自己"}
    ]
  }'
```

::: tip 查询可用模型
不确定该填什么模型时，先调用 `GET /api/v1/models` 获取当前账号可用的全部模型及价格。
:::

## 支持的 API 协议

| 协议 | 说明 | 文档 |
|------|------|------|
| OpenAI Chat Completions | 最通用的对话接口，支持流式、工具调用、多模态 | [协议一](/guide/chat-completions) |
| OpenAI Responses | 新一代对话接口，支持多轮对话状态管理 | [协议二](/guide/responses) |
| Anthropic Messages | 兼容 Claude SDK / Claude Code | [协议三](/guide/anthropic-messages) |

## 模型能力一览

| 能力 | 说明 | 文档 |
|------|------|------|
| 模型列表 | 查询可用模型与定价 | [Models](/guide/models) |
| 图片生成 | 万象 / Qwen Image 系列文生图、图生图 | [Images](/guide/images) |
| 视频生成 | HappyHorse / Wan2.7 异步任务 | [Videos](/guide/videos) |
| 视频生成（Seedance） | Seedance 2.0 / 2.5 文生视频，异步任务 + 网关代理下载 | [Seedance](/guide/seedance) |
| 语音合成 | 文本转语音（HTTP 同步） | [TTS](/guide/tts) |
| 实时语音合成 | WebSocket 流式合成、声音复刻 | [Realtime TTS](/guide/realtime-tts) |
| 语音识别 | 音频转文本 | [ASR](/guide/asr) |
| 文本向量化 | Embeddings | [Embeddings](/guide/embeddings) |
| 重排序 | Rerank | [Rerank](/guide/rerank) |
| 结构化判定 | Decision（`decision-model-preview`，非对话形态） | [Decision](/guide/decision) |

## SDK 快速接入

### JavaScript / TypeScript（OpenAI SDK）

```javascript
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://limapi.com/api/v1",
  apiKey: "sk-xxx",
});

const completion = await client.chat.completions.create({
  model: "qwen3.8-max",
  messages: [{ role: "user", content: "你好" }],
});

console.log(completion.choices[0].message.content);
```

### Python（OpenAI SDK）

```python
from openai import OpenAI

client = OpenAI(
    base_url="https://limapi.com/api/v1",
    api_key="sk-xxx",
)

completion = client.chat.completions.create(
    model="qwen3.8-max",
    messages=[{"role": "user", "content": "你好"}],
)

print(completion.choices[0].message.content)
```

### Python（Anthropic SDK）

```python
import anthropic

client = anthropic.Anthropic(
    base_url="https://limapi.com/api/anthropic",
    api_key="sk-xxx",
)

message = client.messages.create(
    model="claude-sonnet-4-6",
    max_tokens=1024,
    messages=[{"role": "user", "content": "你好"}],
)

print(message.content[0].text)
```

## 计费说明

* 按量计费：每次调用按实际 token 用量 × 模型单价扣费，实时从余额扣除。
* 支持阶梯计费：部分模型按输入 token 数分段定价，详见模型详情页。
* 上下文缓存分「命中」与「写入」两类 token 分别计价，见 [缓存计费](#缓存计费)。
* 组织用户可享受组织折扣（组织统一折扣 / 组织×模型折扣），个人 VIP 用户可配置个人折扣。
* 生成失败自动退款（视频类任务）。

### 缓存计费

命中缓存的输入 token 按**缓存命中价**计（多数模型为输入价的 10%~20%）；本次请求里**写入**缓存的前缀 token 单独按**缓存写入价**计：

* 模型详情页登记了写入价的按登记价计，例如 `kimi-k3`：TTL 5min ¥20、TTL 1h ¥40（元/百万 token）；
* 未登记写入价的模型按输入价的 125% 计（百炼显式缓存口径）。

写入落在哪一档 TTL 由请求里的声明决定，两条协议写法不同：

* `/chat/completions`：请求体顶层的 `prompt_cache_options`，不传即默认 5min 档。

```json
{
  "model": "kimi-k3",
  "messages": [{ "role": "user", "content": "你好" }],
  "prompt_cache_options": { "mode": "implicit", "ttl": "1h" }
}
```

* `/api/anthropic/v1/messages`：断点上的 `cache_control.ttl`（`"5m"` / `"1h"`）。

**只有该模型登记了 1h 档价格时**，声明 `"1h"` 才会按 1h 档计价，否则一律按 5min 档 —— 上游不会因为你声明了 1h 就真按 1h 结算，我们也不会据此多收。

`/responses` 路径暂不支持 TTL 声明，恒按 5min 档计费。

写入 token 数在响应的用量字段里回传：OpenAI 协议为 `usage.prompt_tokens_details.cache_creation_input_tokens`（Kimi 兼容协议字段名为 `cache_write_tokens`，含义相同），Anthropic 协议为 `usage.cache_creation_input_tokens`。

余额、用量与账单请前往 [Portal 控制台](https://limapi.com/) 查看，也可通过 [管理与平台 API](/guide/management) 程序化查询。