开发者文档

当前对外接口保持 OpenAI Chat Completions 与 Models 风格兼容。你只需要准备 API key、当前测试环境的 /v1 地址和模型名，就可以直接复用现有 SDK、服务端代理或脚本工具完成接入。

OpenAI-compatible Bearer Token Server-Sent Events

接口入口

http://82.156.67.142:48137/v1
协议
HTTP / JSON / SSE
认证
Authorization: Bearer

对外接口形状参考 Models 与 Chat Completions 官方文档；字段支持范围以当前平台实现为准。

快速接入

如果你已经接过 OpenAI 风格接口，当前平台的接入方式几乎可以直接照搬。推荐先用最简单的非流式请求跑通，再切换到正式模型和流式输出。

1 创建 API Key
2 读取模型列表
3 发起 Chat Completions 请求 
curl http://82.156.67.142:48137/v1/models \
  -H "Authorization: Bearer sk-your-api-key"

接入前准备

项目 说明
基础地址 测试环境直接使用 http://82.156.67.142:48137/v1 作为 SDK 的 base_url。
认证方式 所有请求统一使用 Bearer Token，格式为 Authorization: Bearer sk-...。
模型名 先调用 GET /v1/models 获取可用模型，再把返回的 id 用于补全请求。
适用场景 适合服务端接入、脚本自动化、内部工具集成和网页应用对话能力扩展。
建议流程 先在工作台生成独立 API key，跑通最小请求，再按业务需要切换到流式、增加系统提示词或并发控制。

SDK 示例

下面的示例都按当前兼容层写法编排，你只需要替换基础地址、模型名和 API key。现有 OpenAI 官方 SDK 通常不需要额外适配。

from openai import OpenAI

client = OpenAI(
    base_url="http://82.156.67.142:48137/v1",
    api_key="sk-your-api-key",
)

resp = client.chat.completions.create(
    model="chat-model",
    messages=[
        {"role": "system", "content": "你是一个简洁的助手。"},
        {"role": "user", "content": "请用一句话介绍这个接口。"},
    ],
)

print(resp.choices[0].message.content)
import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "http://82.156.67.142:48137/v1",
  apiKey: "sk-your-api-key",
});

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

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

认证方式

所有对外 API 请求都使用 Bearer Token 认证：

Authorization: Bearer sk-your-api-key

如果未携带 API key，或使用了不存在、已禁用、超出限制的 key，请求会返回 OpenAI 风格的错误对象。建议不同应用使用不同 key，便于后续统计和定位问题。

GET /v1/models

返回当前账号可用的模型列表。请求与响应形状兼容 OpenAI Models API。

curl http://82.156.67.142:48137/v1/models \
  -H "Authorization: Bearer sk-your-api-key"
字段 类型 说明
object string 固定为 list。
data array 模型对象列表。
data[].id string 模型标识，后续请求中的 model 就使用该值。
data[].object string 固定为 model。
data[].created integer 模型记录创建时间的 Unix 时间戳（秒）。
data[].owned_by string 模型所属方标识。

POST /v1/chat/completions

创建聊天补全。请求形状兼容 OpenAI Chat Completions API，当前实现支持常用文本对话字段。

curl http://82.156.67.142:48137/v1/chat/completions \
  -H "Authorization: Bearer sk-your-api-key" \
  -H "Content-Type: application/json; charset=utf-8" \
  -d '{
    "model": "chat-model",
    "messages": [
      {"role": "user", "content": "你好，请用一句话回复。"}
    ],
    "stream": false
  }'
请求字段 类型 是否必填 说明
model string 是 模型标识，来自 GET /v1/models。
messages array 是 对话消息列表，至少包含一条消息。每条消息通常包含 role 与 content。
stream boolean 否 是否启用流式响应，默认 false。
temperature number 否 采样温度，传入时会透传到上游模型。
top_p number 否 核采样参数，传入时会透传到上游模型。
max_tokens integer 否 控制输出上限，具体效果取决于上游模型能力。

响应字段

响应字段 类型 说明
id string 本次补全请求的唯一标识。
object string 非流式固定为 chat.completion，流式固定为 chat.completion.chunk。
created integer Unix 时间戳（秒）。
model string 本次实际使用的公开模型名。
choices array 补全结果列表，通常取第一项即可。
choices[].message object 非流式下的助手回复内容。
usage object Token 用量统计，包含输入、输出和总计。

流式响应

当 stream=true 时，接口会使用与 OpenAI 兼容的 SSE 形式逐步返回内容。大部分官方 SDK 都可以直接处理，不需要额外改协议层。

如果你要先快速验证联通性，建议先把 stream 设为 false，确认模型、认证和网络都正常后，再切换到流式。

记录与配额

每个账号的调用记录会在工作台中按月展示，当月数据可直接导出。Token 配额、当前套餐和 API key 总消耗会在对应页面同步体现。

如果你在一个账号下同时管理多个应用，建议为每个应用生成单独 API key，这样后续看调用记录和总消耗会更清楚。

错误返回

错误对象保持 OpenAI 风格包装：

{
  "error": {
    "message": "具体错误说明",
    "type": "dev_gateway_error",
    "code": "http_error"
  }
}
字段 说明
message 可直接展示或记录的错误说明。
type 错误来源分类，例如认证、网关、上游服务等。
code 简短错误码，便于程序判断或日志检索。

支持与工单

如果你需要更早的调用历史、套餐升级、企业相关支持或导出额外信息，可以直接通过工单页面联系管理员。管理员回复会在工单页中持续保留，便于后续跟进。

建议在提工单时附上：

  • 问题发生时间
  • 所用 API key 或账号
  • 请求模型与主要参数
  • 返回的错误信息或截图