API 参考文档
OneDim 全部 API 接口的总览与索引。
1. 接口总览
| 接口 | 方法 | 描述 |
|---|---|---|
/v1/chat/completions | POST | 创建聊天对话 |
/v1/responses | POST | OpenAI Responses API |
/v1/messages | POST | Claude Messages API |
/v1/models | GET | 获取模型列表 |
/v1/images/generations | POST | 生成图像 |
/v1/images/edits | POST | 编辑图像 |
/v1/audio/speech | POST | 文本转语音 |
/v1/audio/transcriptions | POST | 音频转录 |
/v1/audio/translations | POST | 音频翻译 |
/sora/v1/videos/* | POST/GET | Sora 视频生成 |
2. 数据模型
Message 对象
{
"role": "user|assistant|system|tool",
"content": "消息内容",
"name": "发送者名称",
"tool_calls": [],
"tool_call_id": "tool_call_id"
}| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
role | string | 是 | 消息角色：system / user / assistant / tool |
content | string / array | 是 | 消息内容，可为文本或多模态内容数组 |
name | string | 否 | 发送者名称 |
tool_calls | array | 否 | 工具调用列表（仅 assistant 角色） |
tool_call_id | string | 否 | 工具调用 ID（仅 tool 角色） |
Choice 对象
{
"index": 0,
"message": {},
"finish_reason": "stop|length|tool_calls|content_filter"
}| 字段 | 类型 | 说明 |
|---|---|---|
index | integer | 选择项索引 |
message | object | 消息内容 |
finish_reason | string | 完成原因 |
Usage 对象
{
"prompt_tokens": 100,
"completion_tokens": 50,
"total_tokens": 150
}| 字段 | 类型 | 说明 |
|---|---|---|
prompt_tokens | integer | 输入 Token 数 |
completion_tokens | integer | 输出 Token 数 |
total_tokens | integer | 总 Token 数 |
Tool 对象
{
"type": "function",
"function": {
"name": "get_weather",
"description": "获取天气信息",
"parameters": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "城市名称"
}
},
"required": ["city"]
}
}
}3. 错误代码
HTTP 状态码
| 状态码 | 说明 |
|---|---|
200 | 请求成功 |
400 | 请求参数错误 |
401 | 认证失败 |
403 | 权限不足 |
404 | 资源不存在 |
429 | 请求频率限制 |
500 | 服务器内部错误 |
503 | 服务不可用 |
错误类型
| 类型 | 说明 |
|---|---|
invalid_request_error | 请求参数错误 |
invalid_api_key | API 密钥无效 |
insufficient_quota | 配额不足 |
rate_limit_exceeded | 频率限制 |
api_error | API 内部错误 |
4. 请求限制
频率限制（按账户等级）
| 等级 | 每分钟请求数 | 并发连接数 |
|---|---|---|
| 免费版 | 60 | 1 |
| 基础版 | 300 | 5 |
| 专业版 | 3000 | 10 |
| 企业版 | 自定义 | 自定义 |
Token 限制（上下文窗口）
| 模型 | 上下文窗口 |
|---|---|
| GPT-5 系列 | 256K |
| Claude 4 系列 | 200K / 1M |
| Gemini 3 系列 | 1M |
5. SDK 和工具
官方 SDK
| 语言 | 包名 | 安装命令 |
|---|---|---|
| Python | openai | pip install openai |
| Node.js | openai | npm install openai |
第三方集成
- LangChain（支持 Python / JavaScript）
- LlamaIndex（适合 RAG 应用）
- Vercel AI SDK（适合前端流式响应）