Hermes Studio API 参考手册:后端集成与自定义扩展

📅 2026/7/6 15:56:11
Hermes Studio API 参考手册:后端集成与自定义扩展
Hermes Studio API 参考手册后端集成与自定义扩展【免费下载链接】hermes-studioWeb dashboard for Hermes Agent — multi-platform AI chat, session management, scheduled jobs, usage analytics项目地址: https://gitcode.com/gh_mirrors/he/hermes-studioHermes Studio 是一款功能强大的多平台 AI 聊天与会话管理工具提供了丰富的 API 接口支持后端集成与自定义扩展。本手册将详细介绍 Hermes Studio API 的核心功能、认证方式、主要接口及使用示例帮助开发者快速上手并实现个性化功能扩展。快速入门API 基础与认证API 版本与基础 URLHermes Studio API 基于 OpenAPI 3.0.3 规范构建当前版本为0.6.25。本地开发环境的基础 URL 为http://localhost:8648认证机制所有 API 请求均需通过Bearer Token认证。在请求头中添加Authorization: Bearer your-api-tokentoken 可通过用户设置页面生成权限范围与用户角色绑定。响应格式API 响应统一采用 JSON 格式标准成功响应示例{ ok: true, data: { /* 响应数据 */ } }错误响应包含error字段描述问题原因状态码遵循 HTTP 标准规范。核心功能 API 详解1. 会话管理 API会话管理是 Hermes Studio 的核心功能支持创建、查询、更新和删除对话会话。创建新会话请求POST /api/hermes/sessions Content-Type: application/json { title: API 集成测试, model: gpt-4, provider: openai }响应{ ok: true, session_id: sess_123456, created_at: 2026-07-05T08:13:45Z }获取会话列表请求GET /api/hermes/sessions?limit10sourceweb响应{ ok: true, sessions: [ { id: sess_123456, title: API 集成测试, created_at: 2026-07-05T08:13:45Z, model: gpt-4 }, // ...更多会话 ] }关键接口列表GET /api/hermes/sessions- 列出所有会话POST /api/hermes/sessions- 创建新会话GET /api/hermes/sessions/{id}- 获取会话详情DELETE /api/hermes/sessions/{id}- 删除会话POST /api/hermes/sessions/{id}/rename- 重命名会话2. 聊天交互 API通过 API 可实现与 AI 模型的交互支持文本输入、上下文管理和流式响应。发送聊天消息请求POST /api/hermes/chat-run/runs Content-Type: application/json { input: 如何使用 Hermes Studio API 创建会话, session_id: sess_123456, provider: openai, model: gpt-4 }响应{ ok: true, status: completed, session_id: sess_123456, output: 创建会话的 API 调用示例如下..., reasoning: 用户需要了解会话创建流程应提供详细步骤和代码示例 }会话上下文管理使用GET /api/hermes/sessions/{id}/context获取当前会话上下文或通过POST /api/hermes/sessions/{id}/context更新上下文配置如最大 tokens 限制。3. 文件操作 API支持文件上传、下载、读取和管理集成工作区文件系统。上传文件请求POST /api/hermes/files/upload Content-Type: multipart/form-data form-data: file: 本地文件 path: /workspace/docs响应{ ok: true, file_path: /workspace/docs/api-reference.pdf, size: 102400 }读取文件内容请求GET /api/hermes/files/read?path/workspace/docs/api-reference.pdf响应{ ok: true, content: base64 编码的文件内容 }4. 技能与插件管理Hermes Studio 支持通过 API 管理技能Skills和插件扩展系统功能。列出所有技能请求GET /api/hermes/skills响应{ ok: true, skills: [ { name: markdown-viewer, category: tools, enabled: true, version: 1.0.0 }, // ...更多技能 ] }启用技能请求PUT /api/hermes/skills/toggle Content-Type: application/json { name: markdown-viewer, enabled: true }高级功能自定义扩展与集成1. 模型配置管理通过 API 自定义模型参数如上下文长度、温度系数等请求PUT /api/hermes/model-context Content-Type: application/json { provider: openai, model: gpt-4, context_limit: 8192 }2. 工作流自动化利用 Jobs API 创建定时任务实现自动化操作请求POST /api/hermes/jobs Content-Type: application/json { name: 每日报告生成, cron: 0 9 * * *, task: { type: chat, session_id: sess_123456, input: 生成今日工作摘要 } }3. 多模态交互支持语音转文字STT和文字转语音TTS功能语音转文字POST /api/hermes/stt/transcribe Content-Type: application/json { audio: base64 编码的音频数据, lang: zh-CN }文字转语音POST /api/hermes/tts/synthesize Content-Type: application/json { text: 欢迎使用 Hermes Studio API, voice: female-1 }可视化管理界面Hermes Studio 提供直观的 Web 管理界面可辅助 API 调试与配置。以下是主要功能界面截图图 1聊天会话管理主界面可查看和操作所有会话图 2模型选择器支持切换不同 AI 模型和提供商图 3文件工作区通过 API 操作的文件将显示在此处错误处理与调试常见错误码401 Unauthorized认证失败检查 token 是否有效400 Bad Request请求参数错误检查请求体格式404 Not Found资源不存在确认 ID 或路径是否正确500 Internal Server Error服务器错误查看响应error字段获取详情调试工具API 文档访问/api/openapi.json获取完整 OpenAPI 规范日志查看通过GET /api/hermes/logs获取系统日志状态监控GET /health检查服务健康状态示例完整集成流程以下是一个创建会话并发送消息的完整示例获取认证 TokenPOST /api/auth/login Content-Type: application/json { username: admin, password: your-password }响应中的token字段用于后续请求。创建会话POST /api/hermes/sessions Authorization: Bearer token Content-Type: application/json { title: API 测试会话 }记录返回的session_id。发送消息POST /api/hermes/chat-run/runs Authorization: Bearer token Content-Type: application/json { input: Hello, Hermes API!, session_id: session_id }获取回复GET /api/hermes/sessions/session_id Authorization: Bearer token总结Hermes Studio API 提供了全面的后端集成能力涵盖会话管理、AI 交互、文件操作、技能扩展等核心功能。通过本手册的指南开发者可以快速实现自定义工作流、集成第三方系统或构建个性化前端界面。如需进一步了解 API 细节可参考官方 OpenAPI 文档docs/openapi.json技能开发指南packages/skills/开始探索 Hermes Studio 的强大功能构建你的 AI 驱动应用吧 【免费下载链接】hermes-studioWeb dashboard for Hermes Agent — multi-platform AI chat, session management, scheduled jobs, usage analytics项目地址: https://gitcode.com/gh_mirrors/he/hermes-studio创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考