聊天完成 API
AiHummer暴露一个 兼容OpenAI 用于文本回合的 HTTP 端点: POST /v1/chat/completions. 任何已经支持 OpenAI 聊天完成格式的客户端或 SDK 都可以通过更改基础 URL 和 API 密钥来与 AiHummer 进行通信——无需任何 AiHummer 特定的代码。
认证
请求使用一个进行身份验证 个人 API 密钥 作为承载者令牌。AiHummer 密钥以…为前缀 ah- 并从网页管理界面发出。
POST /v1/chat/completions HTTP/1.1
Host: your-aihummer.example
Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Content-Type: application/json
[!TIP] 基础 URL 是您的网关地址。在默认安装中,网关会监听 在公共端口上
:8780,所以本地电话打到http://localhost:8780/v1/chat/completions该网关拥有其端口 直接——在前面放置反向代理是运营商的选择,而不是一个 要求。
一个基本请求
发送包含 JSON 的主体 messages,就像你对 OpenAI 一样。 model 该字段选择在您的实例上配置的模型(或代理)。
curl https://your-aihummer.example/v1/chat/completions \
-H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "default",
"messages": [
{ "role": "system", "content": "You are a helpful assistant." },
{ "role": "user", "content": "Summarise our refund policy in two sentences." }
],
"temperature": 0.3
}'
非流式响应遵循熟悉的聊天完成形式:
{
"id": "chatcmpl-...",
"object": "chat.completion",
"created": 1750000000,
"model": "default",
"choices": [
{
"index": 0,
"message": { "role": "assistant", "content": "Refunds are issued within 14 days..." },
"finish_reason": "stop"
}
],
"usage": { "prompt_tokens": 0, "completion_tokens": 0, "total_tokens": 0 }
}
流式响应(SSE)
设置 "stream": true 逐步接收答案作为 服务器发送事件. 每个事件都带有一个 chat.completion.chunk 三角洲,并且河流以最终结束 data: [DONE] 线。
curl -N https://your-aihummer.example/v1/chat/completions \
-H "Authorization: Bearer ah-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
-H "Content-Type: application/json" \
-d '{
"model": "default",
"stream": true,
"messages": [
{ "role": "user", "content": "Write a one-line greeting." }
]
}'
这个回应是一个 text/event-stream:
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"role":"assistant"}}]}
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"Hello"}}]}
data: {"id":"chatcmpl-...","object":"chat.completion.chunk","choices":[{"index":0,"delta":{"content":"!"},"finish_reason":"stop"}]}
data: [DONE]
[!WARNING]
/v1/chat/completions是 只有 OpenAI 兼容的端点 表面。AiHummer 做 不 暴露/v1/models并且做 不 暴露/v1/embeddings— 嵌入是一个内部子系统,无法访问 通过 HTTP。不要依赖那些路由;它们会返回 404。
发现与模式界面
虽然没有 /v1/models 列出,AiHummer 提供了几个探索界面,以便人类和工具可以探索 API:
| 路径 | 它服务于什么 |
|---|---|
GET /docs |
面向人类可读的文档入口 |
GET /docs/api |
交互式 API 浏览器 |
GET /docs/openapi.json |
OpenAPI 3.x 规范 |
GET /openapi.json |
OpenAPI 3.x 规范(根别名) |
GET /docs/llm.json |
用于大型语言模型工具的机器可读 API 摘要 |
GET /llms.txt |
llms.txt LLM 代理的索引 |
# Fetch the OpenAPI spec
curl https://your-aihummer.example/openapi.json
系统端点
两个轻量级、未认证的系统端点有助于存活性和时钟检查:
| 方法与路径 | 目的 |
|---|---|
GET /v1/ping |
返回一个简单的活跃性响应 |
GET /v1/time |
返回网关当前的服务器时间 |
curl https://your-aihummer.example/v1/ping
curl https://your-aihummer.example/v1/time
接下来去哪儿
- 从您自己的应用和自动化中驱动AiHummer: 入站和整合触发器.
- 配对、SSO 联合和协议界面: Webhooks、SCIM 和配对.
- 调整代理可以做的事情: 工具目录.