API 参考

Workflow OpenAPI 3.1 合同的网页版参考:285 个端点,按资源分组,含鉴权要求、路径与查询参数、请求体与响应示例。

合同真值:OpenAPI 3.1(0.1.0)。鉴权见 Agent 接入。

auth

注册、登录、邮箱验证、找回/重置密码(公开端点)

me

当前用户上下文、待接受邀请、活跃组织

orgs

组织与组织成员

projects

项目壳、子域开通、接管

project-members

项目成员与项目角色

project-versions

项目设置·版本管理(Schedule Kernel ReleaseWindow 的项目面读写入口,含设为当前互斥命令)

api-tokens

项目面 API Token(Workflow CLI / Agent PAT)生命周期;仅 cookie session 可管理,PAT 不可自管理

feishu-integrations

项目级飞书入站机器人配置与事件回调;配置经项目设置维护,事件入口走飞书签名校验

invitations

项目邀请、落地与接受

join-requests

主动申请加入项目(邀请的反方向)。申请端点恒返回 202、绝不透露子域上有没有项目, 以免捅穿项目壳可见性边界;反滥用阈值落 platform_settings 运行时可调。

onboarding

项目四步初始化引导(项目面,Host 解析)

acceptance

验收类型与状态配置

audit

审计日志

changes

项目面 ChangeSet/Event 增量读面与对象 activity

object-links

项目面通用 typed object links 只读关联

requirement-graph

需求引用关系与里程碑→需求室→需求→WorkItem 四层图谱

ai

项目面只读 AI 摘要、建议与风险解释

requirements

项目面需求对象与排期字段

requirement-rooms

项目面需求室——按模块/功能聚合需求与缺陷的功能容器;室 CRUD 与对象收纳/移出

work-items

项目面工作项对象、树与排期字段

documents

项目面文档对象、正文版本与需求上下文

comments

宿主对象上的评论讨论(记录“为什么变”的人类讨论)

handoffs

交接纪要(Agent 完成一张单据后留下的 TL;DR 摘要;需求室维度倒序读面)

notifications

站内通知(事件流 × 相关人的 per-user 物化投影;读取自己的通知并标记已读)

schedule

排期快照、依赖关系、里程碑与传播命令

sync

项目级增量变更流——需求 / 子任务 / 缺陷按 updatedAt 时间水位合成一条流(含软删墓碑), 供 Agent 插件把线上单据刷成本地索引;服务器不记任何客户端状态。

admin

平台运营面(Operator Face)超管后台。全部要求 SessionCookie + 平台超管(users.platform_role=superadmin); 非超管一律 403,未登录 401。只读写控制面库,与项目 RBAC 完全正交。T2 覆盖用户管理(列表 / 详情 / 五动作 / 任免超管);T3 补总览 / 组织与项目 / 审计 / 平台配置。

public

公开只读端点,无鉴权。落地页 / 注册页 / 公告条消费的最小平台状态(注册开关 + 公告), 绝不暴露运维外链等其余平台配置。

support

全站客服气泡:公开运行时配置与 Bug/需求收件。收件端点无鉴权(security: []), 提交落进平台配置指定的「支持项目」(仿飞书入站的代填 actor 范式),带 IP 限流。

dev

dev-only 工具端点

workflow-config

工作流配置(模板 / 版本草稿发布 / 类型绑定 / 在途单重绑)。 读端点需 view_project,写端点需 manage_workflows。 旧 all-scope PAT 不含 manage_workflows——凡需写操作请重建令牌(在项目设置 → API Tokens 重新生成)。

research

research 数据后台(research face = research.workflow.games,独立 Host 外壳)。 Host 不解析项目租户;应用层全部端点要求有效会话 + platform_role=superadmin (researchActor guard),与项目 RBAC 完全正交——非超管一律 403、未登录 401。 另有部署层 Zero Trust / IP / VPN 访问控制(CIDR)作为第二重门禁;部署层缺失时生产上线 检查明确失败。公开健康检查只回存活状态,绝不暴露连接器、来源、内部版本或凭据状态; 敏感配置只回 configured / masked 布尔,写入加密且不进日志、Prompt 或事件明文。

market-snapshots

主产品只读市场快照接口(跨面契约,e4)。research 链产出的不可变 marketSnapshotId 是 用户侧方向生成与 OnePage 证据引用的唯一数据源。只暴露 approved Evidence 与当前/指定快照, 不暴露原始抓取凭据、未审核数据或 research 管理动作。会话或 Bearer 均可访问(只读)。

blueprints

组织级立项分析草案(Project Blueprint Draft)。正式 Project 创建前的组织级控制面对象: 仅 Org Admin 可见 / 可创建 / 可编辑 / 可生成 / 可确认 / 可归档;普通组织成员对列表与详情均 不可见,且任何访问都返回通用 404(零感知,不暴露存在性)。草案不进业务库、不带 project_id、 不创建子域或 onboarding 状态。删除采用可恢复归档(archived),不删除已关联正式项目的历史。 本期只交付草案领域骨架(CRUD + 状态机 + CAS 并发 + 审计 + 边界);问卷 / 方向 / OnePage / 配额 / 生成是后续需求(R-00057~62),草案的状态与版本字段为它们预留。

attachments

labels

custom-fields

project-config

search

Workflow 正在加载…