Skip to content

API 文档

New API 提供兼容 OpenAI 格式的 API 接口,你可以使用任何支持 OpenAI API 的客户端进行调用。

基础信息

  • Base URLhttps://your-domain.com/v1
  • 协议:HTTPS
  • 格式:JSON
  • 编码:UTF-8

认证方式

在请求头中携带 API Key:

http
Authorization: Bearer your-api-key

主要接口

聊天 completions

http
POST /v1/chat/completions

请求体:

json
{
  "model": "gpt-4",
  "messages": [
    {"role": "system", "content": "You are a helpful assistant."},
    {"role": "user", "content": "Hello!"}
  ],
  "stream": false
}

模型列表

http
GET /v1/models

余额查询

http
GET /v1/dashboard/billing/subscription

错误码

状态码说明
200成功
400请求参数错误
401认证失败
403权限不足
429请求过于频繁
500服务器内部错误

SDK 示例

Python

python
from openai import OpenAI

client = OpenAI(
    base_url="https://your-domain.com/v1",
    api_key="your-api-key"
)

response = client.chat.completions.create(
    model="gpt-4",
    messages=[{"role": "user", "content": "Hello!"}]
)
print(response.choices[0].message.content)

Node.js

javascript
import OpenAI from 'openai';

const client = new OpenAI({
  baseURL: 'https://your-domain.com/v1',
  apiKey: 'your-api-key'
});

const response = await client.chat.completions.create({
  model: 'gpt-4',
  messages: [{ role: 'user', content: 'Hello!' }]
});
console.log(response.choices[0].message.content);

流式响应

设置 stream: true 启用 SSE 流式响应:

http
POST /v1/chat/completions
Content-Type: application/json

{
  "model": "gpt-4",
  "messages": [{"role": "user", "content": "Hello!"}],
  "stream": true
}

基于 MIT 许可发布