Skip to content

DotCraft Dashboard API

Dashboard API 面向调试界面和内部工具。普通用户通常只需要使用 Dashboard 页面;需要写集成或排查前端问题时再查本页。

Trace 事件类型

类型说明
session.started会话开始
session.completed会话完成
turn.startedAgent 回合开始
turn.completedAgent 回合完成
tool.started工具调用开始
tool.completed工具调用完成
tool.failed工具调用失败
approval.requested需要人工审批
approval.completed审批完成
error运行错误

Dashboard 的 ThinkingResponse trace 事件按连续 streaming 内容段记录,而不是按每个 chunk 记录,也不是整轮强制合并为单条。ThinkingCountResponseCount 因此表示对应内容段数量。实时事件流会在当前段结束并落库时发送该段事件;历史 trace 不迁移,旧数据可能仍保留旧粒度。

端点

GET /DashBoard

返回 Dashboard 页面。

GET /DashBoard/api/summary

返回运行摘要,包括会话数量、最近事件和模块状态。

GET /DashBoard/api/sessions

返回 Dashboard 可见的会话列表。

GET /DashBoard/api/sessions/{sessionKey}/events

返回指定会话的 Trace 事件。

GET /dashboard/api/orchestrators/automations/state

返回 Automations 编排器状态,包括本地任务和 Cron 摘要。

POST /dashboard/api/orchestrators/automations/refresh

请求刷新 Automations 状态。

GET /dashboard/api/config/schema

返回 Dashboard Settings 页面使用的配置 schema。

DELETE /api/sessions/{sessionKey}

删除指定 Dashboard 会话记录。

DELETE /api/sessions

清空 Dashboard 会话记录。

GET /api/events/stream

返回 Dashboard 使用的事件流。

使用建议

  • API 路径大小写沿用现有 Dashboard 路由。
  • 调试本地页面时优先绑定 127.0.0.1
  • 生产或共享网络环境中不要暴露未加保护的 Dashboard。

Apache License 2.0