变更日志

变更日志

Numora 对外 API 开发者预览版的变更记录。

范围

本页记录对外 API 契约和开发者文档中对外可见的变化。

在 developer preview 阶段,变更日志主要覆盖:

  • 新的公开资源
  • 契约澄清
  • 破坏性变更预警
  • provider 或能力可用性变化

2026-03-24

新增了面向 n8n 的出站交付文档,以及 delivery status 记录相关说明。

新增

  • GET /v1/delivery/outbox 的轮询说明,用于拉取已复核且已 finalized 的文档
  • POST /v1/documents/{id}/dispatch 的说明,用于 Numora 托管下游执行
  • GET /v1/documents/{id}/deliveryPOST /v1/documents/{id}/delivery 的说明,用于 callback 模式下的交付日志
  • n8n 出站交付 页面,集中描述推荐的 outbox -> dispatch 集成路径

澄清

  • 推荐的多租户模式是把目标系统连接和 workflow binding 保留在 Numora 内部
  • 已经处于 push_pendingpush_succeeded 的文档不应重新出现在 delivery outbox 中

2026-03-21

建立 developer preview 文档基线。

新增

  • /v1 公共 API 的总览
  • 认证与首个请求说明
  • 文档接入、结果读取与复核动作说明
  • processingreview_requiredreviewed 和未来 push_* 状态说明
  • POST /v1/documents/{id}/actions/rejectPOST /v1/documents/{id}/actions/retry-push
  • GET /v1/workflowsPOST /v1/workflows/{id}/dispatchGET /v1/runs/{id}
  • GET /v1/runs/{id}/logs
  • mappings 与 destinations 说明
  • workflow runs 说明
  • webhook delivery 说明
  • 错误码与限制说明
  • 通用对外 API 约定

澄清

  • 对外 API 被建模为 document operations platform,而不是单一 OCR endpoint
  • 对外契约应优先使用标准化外部模型,而不是泄露内部 OCR 或 provider 存储形态
  • preview 环境中的手动 workflow dispatch 可能会尝试 inline 执行,但客户端仍应默认视为异步
  • 当前活跃 provider 为 dynamics365

已知限制

  • 当前文档对应的是 developer preview 阶段的公开契约
  • 某些文档中的资源与 action 仍可能处于 contract-first 阶段
  • /api/* 下的内部 session routes 不属于 public API surface

Changelog Policy

Numora 应在以下情况更新 changelog:

  • 新增公开 endpoint
  • 响应字段新增、删除或重定义
  • 状态枚举变化
  • provider 或 schema 的可用性变化
  • retry、webhook、auth 或分页行为发生对外可见变化

相关页面