API Overview

Overview of the Numora Public API developer preview for document ingestion, review, mappings, and workflow execution.

Developer Preview

This page introduces the Numora Public API developer preview.

The public API is documented separately from the web app's internal session-based routes. External integrations should use the versioned /v1 contract rather than UI-oriented /api routes.

API Model

Numora is exposed as a document operations platform rather than a single OCR endpoint.

The external model is organized around four layers:

Document ingestion and extraction.
Human review and approval actions.
Route-based outbound delivery.
Destination mappings and write-back setup.
Workflow runs, logs, and retryable automation.

API Areas

Documents

The document resource is the primary entry point for external integrations.

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

The initial schema set is:

invoice_v2
receipt_v1
contract_v1

Dispatch and Delivery Callback

Reviewed documents move through a route-based outbound delivery model.

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

This model supports two integration patterns:

Numora-managed downstream execution, where dispatch resolves the configured route and Numora either runs a workflow or notifies the shared n8n executor
External executor delivery callbacks, where the destination write happens outside Numora

Destinations and Mappings

Destination and mapping resources define how reviewed data is written into downstream systems.

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

The public contract is destination-oriented and avoids exposing provider-specific internal table names as the primary external model.

Workflows and Runs

Workflow resources support advanced orchestration, monitoring, and retryable automation.

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

Integration Pattern

The core integration pattern is:

Ingest documents.
Extract structured fields.
Review low-confidence results.
Push approved data into downstream systems.
Monitor retries and run history.

This model supports operational workflows more effectively than a narrow file-to-JSON API alone.