API Server

API 服务器将 hermes-agent 公开为 OpenAI 兼容的 HTTP 端点。任何使用 OpenAI 格式的前端——Open WebUI、LobeChat、LibreChat、NextChat、ChatBox 以及数百种其他——都可以连接到 hermes-agent 并将其作为后端。

您的智能体使用其完整工具集（终端、文件操作、网页搜索、记忆、技能）处理请求并返回最终响应。流式传输时，工具进度指示器会内联显示，以便前端显示智能体正在执行的操作。

快速开始

1. 启用 API 服务器

添加到 ~/.hermes/.env：

API_SERVER_ENABLED=true
API_SERVER_KEY=change-me-local-dev
# 可选：仅在浏览器必须直接调用 Hermes 时
# API_SERVER_CORS_ORIGINS=http://localhost:3000

2. 启动网关

hermes gateway

您将看到：

[API Server] API server listening on http://127.0.0.1:8642

3. 连接前端

将任何 OpenAI 兼容客户端指向 http://localhost:8642/v1：

# 使用 curl 测试
curl http://localhost:8642/v1/chat/completions \
  -H "Authorization: Bearer change-me-local-dev" \
  -H "Content-Type: application/json" \
  -d '{"model": "hermes-agent", "messages": [{"role": "user", "content": "Hello!"}]}'

或连接 Open WebUI、LobeChat 或任何其他前端——请参阅 Open WebUI 集成指南 获取分步说明。

端点

POST /v1/chat/completions

标准 OpenAI Chat Completions 格式。无状态——完整对话通过 messages 数组包含在每个请求中。

请求：

{
  "model": "hermes-agent",
  "messages": [
    {"role": "system", "content": "You are a Python expert."},
    {"role": "user", "content": "Write a fibonacci function"}
  ],
  "stream": false
}

响应：

{
  "id": "chatcmpl-abc123",
  "object": "chat.completion",
  "created": 1710000000,
  "model": "hermes-agent",
  "choices": [{
    "index": 0,
    "message": {"role": "assistant", "content": "Here's a fibonacci function..."},
    "finish_reason": "stop"
  }],
  "usage": {"prompt_tokens": 50, "completion_tokens": 200, "total_tokens": 250}
}

流式传输（"stream": true）：返回 Server-Sent Events（SSE），包含逐令牌响应块。对于 Chat Completions，流使用标准 chat.completion.chunk 事件加上 Hermes 自定义的 hermes.tool_progress 事件以实现工具开始 UX。对于 Responses，流使用 OpenAI Responses 事件类型，如 response.created、response.output_text.delta、response.output_item.added、response.output_item.done 和 response.completed。

流中的工具进度：

• Chat Completions：Hermes 发出 event: hermes.tool_progress 以便工具开始可见，而不污染持久化的助手文本。
• Responses：Hermes 在 SSE 流中发出符合规范的 function_call 和 function_call_output 输出项，以便客户端实时渲染结构化工具 UI。

POST /v1/responses

OpenAI Responses API 格式。通过 previous_response_id 支持服务器端对话状态——服务器存储完整对话历史（包括工具调用和结果），因此多轮上下文得以保留，无需客户端管理。

请求：

{
  "model": "hermes-agent",
  "input": "What files are in my project?",
  "instructions": "You are a helpful coding assistant.",
  "store": true
}

响应：

{
  "id": "resp_abc123",
  "object": "response",
  "status": "completed",
  "model": "hermes-agent",
  "output": [
    {"type": "function_call", "name": "terminal", "arguments": "{\"command\": \"ls\"}", "call_id": "call_1"},
    {"type": "function_call_output", "call_id": "call_1", "output": "README.md src/ tests/"},
    {"type": "message", "role": "assistant", "content": [{"type": "output_text", "text": "Your project has..."}]}
  ],
  "usage": {"input_tokens": 50, "output_tokens": 200, "total_tokens": 250}
}

使用 previous_response_id 进行多轮对话

链接响应以跨轮次维护完整上下文（包括工具调用）：

{
  "input": "Now show me the README",
  "previous_response_id": "resp_abc123"
}

服务器从存储的响应链重建完整对话——所有先前的工具调用和结果都被保留。链接的请求也共享相同的会话，因此多轮对话在仪表板和会话历史中显示为单个条目。

命名对话

使用 conversation 参数而不是跟踪响应 ID：

{"input": "Hello", "conversation": "my-project"}
{"input": "What's in src/?", "conversation": "my-project"}
{"input": "Run the tests", "conversation": "my-project"}

服务器自动链接到该对话中的最新响应。类似于网关会话的 /title 命令。

GET /v1/responses/{id}

按 ID 检索以前存储的响应。

DELETE /v1/responses/{id}

删除存储的响应。

GET /v1/models

将智能体列为可用模型。公布的模型名称默认为profile名称（或默认 profile 的 hermes-agent）。大多数前端需要此功能来进行模型发现。

GET /health

健康检查。返回 {"status": "ok"}。也可在 GET /v1/health 获取，以供需要 /v1/ 前缀的 OpenAI 兼容客户端使用。

系统提示处理

当前端发送 system 消息（Chat Completions）或 instructions 字段（Responses API）时，hermes-agent 在其核心系统提示之上分层。您的智能体保留其所有工具、记忆和技能——前端的系统提示添加额外指令。

这意味着您可以每个前端自定义行为而不丢失功能：

• Open WebUI 系统提示："你是一个 Python 专家。始终包含类型提示。"
• 智能体仍然有终端、文件工具、网页搜索、记忆等。

认证

通过 Authorization 头的 Bearer token 认证：

Authorization: Bearer ***

通过 API_SERVER_KEY 环境变量配置密钥。如果需要浏览器直接调用 Hermes，还需要将 API_SERVER_CORS_ORIGINS 设置为显式允许列表。

安全性

API 服务器提供对 hermes-agent 工具集的完全访问权限，包括终端命令。绑定到非回环地址（如 0.0.0.0）时，API_SERVER_KEY 是必需的。同时保持 API_SERVER_CORS_ORIGINS 狭窄以控制浏览器访问。

默认绑定地址（127.0.0.1）仅供本地使用。浏览器访问默认禁用；仅为明确的受信任来源启用。

配置

环境变量

变量	默认值	描述
API_SERVER_ENABLED	false	启用 API 服务器
API_SERVER_PORT	8642	HTTP 服务器端口
API_SERVER_HOST	127.0.0.1	绑定地址（默认仅本地）
API_SERVER_KEY	(无)	认证 Bearer token
API_SERVER_CORS_ORIGINS	(无)	逗号分隔的允许浏览器来源
API_SERVER_MODEL_NAME	(profile name)	/v1/models 上的模型名称。默认为 profile 名称或默认 profile 的 hermes-agent。

config.yaml

# 尚不支持——使用环境变量。
# config.yaml 支持将在未来版本中提供。

安全头

所有响应都包含安全头：

• X-Content-Type-Options: nosniff — 防止 MIME 类型嗅探
• Referrer-Policy: no-referrer — 防止引用者泄漏

CORS

API 服务器默认不启用浏览器 CORS。

对于直接浏览器访问，设置显式允许列表：

API_SERVER_CORS_ORIGINS=http://localhost:3000,http://127.0.0.1:3000

启用 CORS 时：

• 预检响应包含 Access-Control-Max-Age: 600（10 分钟缓存）
• SSE 流式响应包含 CORS 头，以便浏览器 EventSource 客户端正常工作
• Idempotency-Key 是允许的请求头——客户端可以发送它进行去重（响应按 key 缓存 5 分钟）

大多数记录的前端（如 Open WebUI）使用服务器到服务器连接，完全不需要 CORS。

兼容的前端

任何支持 OpenAI API 格式的前端都可以工作。已测试/已记录的集成：

前端	Stars	连接方式
Open WebUI	126k	提供完整指南
LobeChat	73k	自定义提供商端点
LibreChat	34k	librechat.yaml 中的自定义端点
AnythingLLM	56k	通用 OpenAI 提供商
NextChat	87k	BASE_URL 环境变量
ChatBox	39k	API Host 设置
Jan	26k	远程模型配置
HF Chat-UI	8k	OPENAI_BASE_URL
big-AGI	7k	自定义端点
OpenAI Python SDK	—	OpenAI(base_url="http://localhost:8642/v1")
curl	—	直接 HTTP 请求

使用 Profiles 的多用户设置

要为多个用户提供各自隔离的 Hermes 实例（独立配置、记忆、技能），请使用 profiles：

# 为每个用户创建一个 profile
hermes profile create alice
hermes profile create bob

# 在不同端口上配置每个 profile 的 API 服务器
hermes -p alice config set API_SERVER_ENABLED true
hermes -p alice config set API_SERVER_PORT 8643
hermes -p alice config set API_SERVER_KEY alice-secret

hermes -p bob config set API_SERVER_ENABLED true
hermes -p bob config set API_SERVER_PORT 8644
hermes -p bob config set API_SERVER_KEY bob-secret

# 启动每个 profile 的网关
hermes -p alice gateway &
hermes -p bob gateway &

每个 profile 的 API 服务器自动公布 profile 名称作为模型 ID：

• http://localhost:8643/v1/models → 模型 alice
• http://localhost:8644/v1/models → 模型 bob

在 Open WebUI 中，将每个添加为单独的连接。模型下拉列表显示 alice 和 bob 作为不同的模型，每个由完全隔离的 Hermes 实例支持。详情请参见 Open WebUI 指南。

限制

• 响应存储 — 存储的响应（用于 previous_response_id）持久化在 SQLite 中，可以在网关重启后存活。最多 100 个存储响应（LRU 逐出）。
• 不支持文件上传 — 通过上传的文件进行视觉/文档分析尚不支持通过 API。
• 模型字段是装饰性的 — 请求中的 model 字段被接受，但实际使用的 LLM 模型在 config.yaml 中服务器端配置。

代理模式

API 服务器还作为网关代理模式的后端。当另一个 Hermes 网关实例配置了指向此 API 服务器的 GATEWAY_PROXY_URL 时，它会将所有消息转发到这里而不是运行自己的智能体。这支持分离部署——例如，处理 Matrix E2EE 的 Docker 容器中继到主机端智能体。

请参阅 Matrix 代理模式 获取完整的设置指南。