Files
heicode/docs
chenchenandClaude Opus 4.8 d2d9a22ae4 docs(client-api): add available-models, config, telemetry, agent usage + hidden-token billing semantics (#35, #30)
Bring docs/integration/heicode-desktop-client-api.md in lock-step with merged
endpoints:

- §3.1 /api/heicode/available-models: logged-in user model list is the single
  source of truth (no local presets / no CodeGW channel backend); exposes only
  model_id/display_name/default; forbidden fields enumerated.
- §5.1 /api/heicode/agents/{id}/usage: token-name aggregation, time window,
  empty-data semantics, relation to billing logs. Includes the #30 hidden agent
  model token billing-collection semantics: UnlimitedQuota only waives the
  token's own remaining-quota cap, it does NOT bypass user.Quota — HM still
  checks user quota and settles to wallet/subscription via the billing
  expression; token revoked on stop/delete; hidden from user UI but auditable.
- §7.1 /api/heicode/config: telemetry enabled/endpoint/max_batch/flush/retention_days.
- §7.2 /api/heicode/telemetry/events: default-off 410 kill switch, V2 device
  signature, top-level array 1-20 / <=256KB, server redaction, context field
  whitelist (#32), 4xx-drop/5xx-retry, retention; production enable-gate note.
- Updated §10 endpoint inventory.

Docs-only; no code change. heicodeDocs org-level sync tracked in #34.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-10 00:45:29 +08:00
..

Heicode Docs

当前 docs/ 只保留五类主线文档:

文档 用途
heicode.md Heicode 当前产品定位、系统边界和架构共识
plan.md 按当前共识拆出的实施计划
heicode-runtime-auth-newapi-secret-design.md 用户输入、登录用户复用、NewAPI 扣费映射、Azure Key Vault 凭证托管与短期凭证注入边界
integration/heicode-hm-template-agent-model.md 当前模型:模板 Agent + 客户端直连,HM 端后端/前端改造说明
integration/heicode-hm-legacy-teardown.md 旧 sub 任务编排模型的代码/表/前端删除清单
integration/heicode-desktop-client-api.md 桌面客户端对接 HM(模板 Agent 模型),已生产验证
integration/heicode-am-contract.md HM ↔ AM(agent_management)接口契约
integration/heicode-swarm-deferred.md 蜂群(Swarm)现状裁定与后续跟踪入口:HM 当前不实现 swarm runtime,旧 sub/蜂群文档作废后的上下文迁移映射与归属(AM/Swarm 侧)
deployment/azure-production-deploy-guardrails.md Azure VM / PostgreSQL / Redis / Agent / NewAPI 生产部署前的安全守卫、环境变量注入和验证计划

旧 Agent API 草案、旧 sub / 蜂群任务编排、旧里程碑、旧架构说明和旧上手材料不再作为实施依据(相关文档已删除)。蜂群相关文档的作废/迁移映射与「HM 不实现 swarm runtime、新能力归 AM/Swarm 侧跟踪」的结论见 integration/heicode-swarm-deferred.md(删除≠丢上下文,迁移到此追踪入口)。 当前实施模型以 heicode.md、plan.md 与 integration/heicode-hm-template-agent-model.md 为准;生产部署操作以安全守卫文档约束,且不得覆盖产品/架构主线。

代码中的过渡期命名、旧接口注释或旧 UI 文案只作为现状参考;若与 heicode.md / plan.md 冲突,应先更新实现或另行补充当前主线文档,不得恢复旧 Agent/M1-M5 草案作为依据。