Files
hunjing/docs/contracts/api-surface.md
T
chenxin 42513d13c6 📝 docs: 建立魂镜完整 1.0 设计文档体系
- 产品层:产品宪章与永久禁域、产品定义、完整 1.0 范围与发布门、道家文化语言体系、指标与反指标
- 研究层:参考项目研究(deepseek-harness、pi、MemOS、模型网关)、灵台原生引擎研究(业界原生引擎架构理念与道家文化出处)
- 架构层:系统、Agent 运行时(周天体系)、插件系统、灵台引擎(C++ 双形态)、媒体与设备、社区协作市场、前端富内容渲染、数据、记忆与知识
- 契约层:协议与稳定标识、API 总体约定、Native API、兼容网关、实时与 Webhook、内部端口、统一 ContentBlock 与流式(含分支对话交互态)、灵台 C ABI 与 gRPC Service、API 表面、HTTP 与事件、运行观测
- 决策:ADR-001 至 ADR-023(模块化单体、每 attempt 持久化、候选记忆、OAuth 2.1、灵台引擎、双形态部署、大周天演化、宪章、三界作用域、私箧与保全态、叩心、周天统一等)
- 交付:WP-01 至 WP-15 实施 TODO 与设计阶段交接文档
- 工程:AGENTS.md 工程规则(含 C++/灵台规范)、CLAUDE.md 引用、.gitignore
2026-09-09 21:07:14 +08:00

2.8 KiB
Raw Blame History

1.0 API 表面总表

本表用于检查 API 是否覆盖完整 1.0;详细字段以 OpenAPI 3.1 和对应契约文档为准。

域 Native REST SSE/WS Internal/Plugin Webhook
Identity /me、domains、service accounts、devices — Auth/Scope Ports Identity Provider inbound
Character characters、versions、imports、exports、forks、assets — Importer/Exporter release events outbound
Conversation conversations、branches、messages、revisions、统一 ContentBlock Block/Run SSE Context/Normalization Port message/run outbound
Agent agents、runs、approvals、children Run SSE Model/Tool/Sandbox Ports run outbound
Memory candidates、memories、searches、knowledge — Memory Policy Plugin memory outbound
Media uploads、files、media jobs、voices、avatars Voice WS Media Plugin/Worker media Provider inbound
Device devices、grants、sessions Device WS Tauri Capability Port device outbound
Plugin plugins、versions、installations、MCP、skills status events Plugin JSON-RPC/MCP plugin outbound
Community profiles、content、comments、reactions、feeds、reports Notification SSE Search/Moderation Ports content/moderation outbound
Inbox threads、members、messages notification/presence Moderation Port message outbound
Collaboration workspaces、projects、revisions、reviews Collaboration WS Document/CRDT Port workspace outbound
Marketplace listings、releases、entitlements notification Catalog/License Ports listing/order outbound
Finance orders、payment sessions、refunds、balances、settlements notification Payment/Ledger Ports payment Provider inbound
Diagnostics grants、run diagnostics optional diagnostic SSE Observability Ports no sensitive outbound
Model Gateway no Native inference endpoint protocol SSE Normalized Model Port —

兼容入口

OpenAI:    /openai/v1/models
           /openai/v1/responses
           /openai/v1/chat/completions
           /openai/v1/embeddings
           /openai/v1/images/generations
           /openai/v1/audio/transcriptions
           /openai/v1/audio/speech

Anthropic: /anthropic/v1/models
           /anthropic/v1/messages
           /anthropic/v1/messages/count_tokens

尚待发布配置,而非 API 结构不确定项

以下在实现期以配置/TODO 落实,不改变上述资源模型:

  • 首发支付、KYC、税务、对象存储、ASR/TTS、图像与模型 Provider;
  • 默认分页上限、媒体大小、Run/Agent 并发和各类 Rate Limit 数值;
  • 首发地区、币种、税类、内容年龄分级和保留期限;
  • 结算周期、退款窗口、平台费、准备金和争议时限;
  • 兼容 API 支持的具体 Provider beta 功能清单。