Changelog

Scope

This page tracks externally relevant changes to the Numora Public API contract and developer documentation.

During developer preview, changelog entries may describe:

Initial developer preview documentation baseline.

Public API overview for the /v1 contract.
Authentication and first-request guidance.
Document API contract for ingestion, result retrieval, and review actions.
Document lifecycle guidance for processing, review_required, reviewed, and future push_* states.
Review and approval guidance, including review_state, approval semantics, and optimistic concurrency.
POST /v1/documents/{id}/actions/reject and POST /v1/documents/{id}/actions/retry-push are now available in developer preview.
GET /v1/workflows, POST /v1/workflows/{id}/dispatch, and GET /v1/runs/{id} are now available in developer preview.
GET /v1/runs/{id}/logs is now available in developer preview.
Mappings and destinations guidance for schema catalog, destination resources, and downstream mapping design.
Workflow runs guidance for workflow listing, dispatch, run detail, and node-level logs.
Webhook delivery guidance.
Error codes and limits reference.
Shared public API conventions for idempotency, errors, headers, and asynchronous behavior.

The public API is modeled as a document operations platform, not a single OCR endpoint.
The public contract should use normalized external models such as document.status and destination, rather than leaking internal OCR or provider storage shapes.
Manual workflow dispatch may execute inline in preview environments, but clients should treat dispatch as asynchronous by default.
dynamics365 is the currently active destination provider; other providers remain planned.

The documented public API contract is still in developer preview.
Some documented action routes and resources are contract-first and may not yet be fully implemented under /v1.
Internal session routes under /api/* are not the public API surface.

Numora should add a new changelog entry whenever one of these happens:

A new public endpoint is introduced.
A response field is added, removed, or redefined.
A status enum changes.
A provider or schema changes availability.
Retry, webhook, auth, or pagination behavior changes in an externally visible way.

Outbound delivery guidance for n8n and delivery status tracking is now documented.

GET /v1/delivery/outbox guidance for polling reviewed and finalized documents
POST /v1/documents/{id}/dispatch guidance for Numora-managed downstream execution
GET /v1/documents/{id}/delivery and POST /v1/documents/{id}/delivery guidance for callback-based delivery logging
n8n Outbound Delivery page covering the recommended outbox -> dispatch integration pattern

The recommended multi-tenant model keeps destination credentials and workflow bindings inside Numora
push_pending and push_succeeded documents are not intended to reappear in the delivery outbox