NumoraNumora
API 参考

API 概览

Numora 对外 API 开发者预览版概览，覆盖文档接入、复核、映射与工作流执行。

开发者预览版

本页介绍 Numora 对外 API 的开发者预览版。

对外 API 与当前 Web 应用内部使用的 session 路由分离。外部集成应使用版本化的 /v1 契约，而不是面向界面的 /api 路由。

API 模型

Numora 对外被定义为文档运营平台，而不是单一 OCR 接口。

对外模型围绕四层能力展开：

  • 文档接入与提取。
  • 人工复核与确认动作。
  • 出站交付编排。
  • 目标系统映射与回写配置。
  • 工作流运行、日志与重试自动化。

API 组成

Documents

文档资源是外部集成的主入口。

  • POST /v1/documents
  • GET /v1/documents/{id}
  • GET /v1/documents/{id}/result
  • POST /v1/documents/{id}/actions/approve
  • POST /v1/documents/{id}/actions/reject
  • POST /v1/documents/{id}/actions/retry-push

首批 schema 包括：

  • invoice_v2
  • receipt_v1
  • contract_v1

Delivery Outbox 与 Dispatch

已复核文档可以通过面向交付的出站模型被外部系统消费。

  • GET /v1/delivery/outbox
  • POST /v1/documents/{id}/dispatch
  • GET /v1/documents/{id}/delivery
  • POST /v1/documents/{id}/delivery

当前支持两种模式：

  • Numora 管理下游执行，由 n8n 调用 dispatch，Numora 复用已保存的连接与 workflow
  • 外部执行后回执，由外部 worker 完成目标系统写入，再把结果回写到 Numora

相关页面：

Destinations 与 Mappings

Destination 与 mapping 资源用于定义复核后数据如何写入下游系统。

  • GET /v1/schemas
  • GET /v1/destinations
  • POST /v1/destinations
  • POST /v1/destinations/{id}/test
  • GET /v1/mappings/{schema}/{destination}
  • PUT /v1/mappings/{schema}/{destination}

对外契约围绕 destination 建模，不以 provider 内部表名作为主要公开模型。

Workflows 与 Runs

Workflow 资源支持更高级的编排、监控与可重试自动化。

  • GET /v1/workflows
  • POST /v1/workflows/{id}/dispatch
  • GET /v1/runs/{id}
  • GET /v1/runs/{id}/logs

集成模式

Numora 的核心集成链路是：

  1. 接收文档。
  2. 提取结构化字段。
  3. 对低置信度结果进行复核。
  4. 将确认后的数据回写到下游系统。
  5. 跟踪日志、失败与重试。

这比单点文件转 JSON 的接口更适合真实业务流程。

开发者资源

安全与合规

Numora OCR 数据在生产环境中的基础安全实践。

文档资源

Numora 对外 API 中文档接入、状态读取与复核动作的请求和响应模型。

On this page

开发者预览版
API 模型
API 组成
Documents
Delivery Outbox 与 Dispatch
Destinations 与 Mappings
Workflows 与 Runs
集成模式
开发者资源