API 接口文档
我们提供完全兼容 OpenAI 格式的 API 接口,可以直接使用 OpenAI 的客户端 SDK 调用。
基础信息
| 项目 | 内容 |
|---|---|
| API Base URL | https://api.yoursite.com/v1 |
| 鉴权方式 | Bearer Token (API Key) |
| 请求格式 | JSON / SSE |
可用接口
- Chat Completions — 对话生成
- 流式输出 (SSE) — 流式响应
- Images 图像 — 图像生成与编辑
- Audio 语音 — 语音识别与合成
- Embeddings 向量 — 文本向量化
通用请求头
| 头 | 必填 | 说明 |
|---|---|---|
Authorization | 是 | Bearer sk-your-api-key |
Content-Type | 是 | application/json |
通用响应格式
json
{
"id": "chatcmpl-xxx",
"object": "chat.completion",
"created": 1234567890,
"model": "gpt-4o",
"choices": [...],
"usage": {
"prompt_tokens": 10,
"completion_tokens": 20,
"total_tokens": 30
}
}