Appearance
接口兼容总览
LLMGateway 的 /v1 接口面向 OpenAI-compatible 客户端。除特别说明外,请使用:
text
Base URL: https://llm.xiaoyue9527.xyz/v1
Authorization: Bearer sk-gtw-REPLACE_ME
Content-Type: application/jsonAnthropic-compatible 客户端也可以使用 x-api-key: sk-gtw-REPLACE_ME。
测试环境和正式环境的 Base URL 由文档站构建配置注入,不要混用。
兼容入口
如果客户系统会自动拼接 /v1/chat/completions、/v1/messages 这类后缀,建议使用兼容入口,避免客户理解 LLMGateway 内部 /v2 路径:
| 客户端类型 | Base URL |
|---|---|
| OpenAI SDK(需要显式传入 v1 base_url) | https://llm.xiaoyue9527.xyz/compatible/v1 |
NewAPI / OneAPI 类平台(会自动补 /v1/...) | https://llm.xiaoyue9527.xyz/compatible |
Anthropic SDK(会自动请求 /v1/messages) | https://llm.xiaoyue9527.xyz/compatible |
当前兼容入口只开放白名单接口:
| 兼容入口 | 内部实现 | 说明 |
|---|---|---|
POST /compatible/v1/chat/completions | /v2/chat/completions | OpenAI Chat 兼容,保留 V2 的 reasoning/usage 行为 |
POST /compatible/v1/messages | /v2/messages | Anthropic Messages 兼容 |
POST /compatible/v1/messages/count_tokens | /v2/messages/count_tokens | Anthropic token 预估 |
GET /compatible/v1/models | /v1/models | 模型列表 |
GET /compatible/v1/models/{model} | /v1/models/{model} | 单模型查询 |
/compatible 本身只返回说明 JSON,不会把任意路径泛转发到网关内部接口。
已支持接口
| 接口 | SDK 方法 | 文档 | 说明 |
|---|---|---|---|
GET /v1/models | client.models.list() | 模型列表 | 返回当前可用模型列表 |
GET /v1/models/{model} | client.models.retrieve(model) | 模型列表 | 查询单个模型 |
GET /v1/model-catalog | HTTP API | 模型列表 | 返回模型能力、模态、任务分类 |
GET /v1/model-catalog/{model} | HTTP API | 模型列表 | 查询单个模型的能力、模态、任务分类 |
POST /v1/chat/completions | client.chat.completions.create() | Chat Completions | 文本/多模态对话,支持 SSE |
POST /v2/chat/completions | client.chat.completions.create() | Chat V2 | OpenAI 兼容,SSE 更严格遵循 stream_options |
POST /v1/responses | client.responses.create() | Responses | 部分兼容:文本/图片输入、文本输出、SSE 和有限取消能力 |
POST /v1/embeddings | client.embeddings.create() | Embeddings | 文本向量化 |
POST /v1/rerank | HTTP API | Rerank | 文档重排序,支持文本和图片 |
POST /v1/video/generations/tasks | HTTP API | 视频生成任务 | 异步视频生成,查询任务状态和结果 |
POST /v1/messages | Anthropic SDK | Anthropic Messages | Anthropic Messages 兼容接口 |
POST /v1/messages/count_tokens | Anthropic SDK | Anthropic Messages | 本地估算 token 数,不计费 |
通用响应
OpenAI-compatible /v1/* 接口不包裹公司内部 {code,message,data}。成功响应保持对应协议格式;网关自身生成的失败响应使用 OpenAI 风格 error envelope:
json
{
"error": {
"message": "upstream service temporarily unavailable",
"type": "upstream_error",
"code": "502"
}
}如果上游服务返回了有意义的错误体,网关可能保留上游 HTTP 状态码及 JSON/文本错误内容。客户端应先按 HTTP 状态码处理,并兼容错误体不含 error.message 的情况。
通用边界
| 项 | 说明 |
|---|---|
| 鉴权 | 必须传 Authorization: Bearer <API Key>;Anthropic-compatible 客户端可改用 x-api-key: <API Key> |
| 模型名 | 大小写敏感,以 /v1/models 返回为准 |
| 能力判断 | 使用 /v1/model-catalog 查看 modalities、tasks、features |
| 流式 | Chat Completions 和 Responses 支持 SSE |
| 文件上传 | 暂未开放 /v1/files 文件管理能力 |
| 未启用接口 | 返回 501 unsupported_feature,见 不支持接口 |