OpenAI Compatible

Lumi API 开发者文档

使用一个统一的 OpenAI 兼容接口，快速接入主流 AI 模型。本文档将带你完成 API Key 获取、SDK 配置、聊天接口调用和常见错误排查。

Base URL

所有 OpenAI 兼容请求都使用下面的 Base URL：

https://api.lumiapi.xyz/v1

提示：在 Cherry Studio、Cursor、Cline、Open WebUI 等客户端里，把 OpenAI Base URL 改成这个地址即可。

获取 API Key

打开 Lumi API 控制台并登录。
进入「令牌管理」。
点击「添加令牌」。
复制生成的 API Key。

前往注册

认证方式

请求时在 Header 中携带 Bearer Token：

Authorization: Bearer YOUR_LUMI_API_KEY

不要把 API Key 暴露在前端网页、公开仓库或截图中。

Python 示例

from openai import OpenAI
```

client = OpenAI(
api_key="你的 Lumi API Key",
base_url="https://api.lumiapi.xyz/v1"
)

response = client.chat.completions.create(
model="gpt-4.1-mini",
messages=[
{"role": "user", "content": "你好，介绍一下 Lumi API"}
]
)

print(response.choices[0].message.content)

```

JavaScript 示例

import OpenAI from "openai";
```

const client = new OpenAI({
apiKey: "你的 Lumi API Key",
baseURL: "https://api.lumiapi.xyz/v1"
});

const response = await client.chat.completions.create({
model: "gpt-4.1-mini",
messages: [
{ role: "user", content: "Hello Lumi API" }
]
});

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

```

Curl 示例

curl https://api.lumiapi.xyz/v1/chat/completions \
```

-H "Authorization: Bearer YOUR_LUMI_API_KEY" 
-H "Content-Type: application/json" 
-d '{
"model": "gpt-4.1-mini",
"messages": [
{"role": "user", "content": "Hello Lumi API"}
]
}'

```

聊天接口

接口地址：

POST /v1/chat/completions

参数	说明
model	模型名称，例如 gpt-4.1-mini
messages	对话消息数组
temperature	随机性，通常 0.2 - 1.0
stream	是否启用流式输出

模型列表

当前建议开放这些常用模型：

gpt-4.1 gpt-4.1-mini gpt-4o gpt-4o-mini o4-mini text-embedding-3-small text-embedding-3-large

Embedding

response = client.embeddings.create(
model="text-embedding-3-small",
input="Lumi API 是一个 AI API 平台"
```

)

print(response.data[0].embedding)

```

常见错误码

状态码	含义	处理方法
400	请求参数错误	检查 model、messages、max_tokens 等参数
401	认证失败	检查 API Key 是否正确
403	权限不足	检查账号额度和模型权限
429	请求过快	降低并发或稍后重试
500	上游服务异常	稍后重试或切换模型

速率限制

速率限制会根据账号分组、渠道、模型和额度策略调整。正式使用前建议先在控制台测试模型可用性。

FAQ

是否兼容 OpenAI SDK？

兼容。只需要修改 base_url 为 https://api.lumiapi.xyz/v1。

可以在客户端使用吗？

可以，支持 Cherry Studio、Cursor、Cline、Open WebUI 等。

如何查看消耗？

登录控制台，在使用日志和额度页面查看。

如何充值？

支付功能上线后，可在钱包管理中充值。