API 开发文档

OpenAI 兼容接口,5 分钟快速接入

快速开始

平台提供与 OpenAI 完全兼容的 REST API。注册后创建 API Key,即可开始调用。

Base URL

BASE https://your-domain.com/api/v1

一个最小示例(Python)

# pip install openai from openai import OpenAI client = OpenAI( base_url="https://your-domain.com/api/v1", api_key="sk-xxxxxxxx", ) resp = client.chat.completions.create( model="gpt-4o", messages=[{"role": "user", "content": "你好"}], ) print(resp.choices[0].message.content)

鉴权方式

在用户中心创建 API Key,通过请求头传递:

# 请求头 Authorization: Bearer sk-xxxxxxxx

密钥应严格保密,仅存于服务端。如泄露请在用户中心及时删除重建。

对话补全

POST /api/v1/chat/completions
{ "model": "gpt-4o", "messages": [ {"role": "system", "content": "你是一个助手"}, {"role": "user", "content": "介绍一下你自己"} ], "temperature": 0.7, "max_tokens": 1024, "stream": false }

支持流式返回(stream: true),以 SSE 格式实时输出。

图像生成

POST /api/v1/images/generations
{ "model": "dall-e-3", "prompt": "A cat playing piano", "size": "1024x1024" }

向量嵌入

POST /api/v1/embeddings
{ "model": "text-embedding-3-small", "input": "需要向量化的文本" }

模型列表

GET /api/v1/models

返回当前平台上架的全部模型及其价格信息。

余额查询

GET /api/v1/balance
{ "balance": 12.345, "currency": "cny", "is_available": true }

错误码

HTTP 状态含义
401API Key 无效或缺失
402余额不足
404模型不存在或未上架
429请求过于频繁
502上游渠道异常
503无可用上游渠道