KERNIT Documentation
API Versions
The current KERNIT OpenAPI contract version is 2026-05-12. Public routes stay stable where possible; breaking contract changes require a new documented version or variant before integrations are expected to move.
Current Version#
| Surface | Current value |
|---|---|
| OpenAPI version | 3.1.0 |
| KERNIT API contract | 2026-05-12 |
| Production host | https://api.kernit.org |
| Public schema | /docs/openapi.json |
| Current snapshot | /docs/api/versions/2026-05-12/openapi.json |
Published Version Tracks#
| Track | Status | Docs entry |
|---|---|---|
| 2026-05-12 current | stable | /docs/api/versions/current |
| next preview | preview | /docs/api/versions/next |
Historical OpenAPI Snapshots#
| Version | Status | Operations | Schema |
|---|---|---|---|
2026-05-11 | stable | 8 | /docs/api/versions/2026-05-11/openapi.json |
2026-05-12 | stable | 9 | /docs/api/versions/2026-05-12/openapi.json |
Compatibility Policy#
- New optional response fields and optional request fields can ship inside the current contract.
- Removing fields, changing required request fields, or changing endpoint semantics requires a documented version track before customer integrations are expected to migrate.
- Endpoint pages, snippets, and playground forms are derived from the OpenAPI source for the current contract.
Release Gate#
Every docs release runs npm run docs:openapi:diff. The gate requires the current OpenAPI contract to match a versioned snapshot, requires snapshot filenames to match info.version, and rejects obvious breaking changes between published snapshots.
Snippet Strategy#
Endpoint snippets read OpenAPI operation metadata. Complete Node, Python, and cURL integration pages stay aligned with the docs source as canonical workflow templates until an official KERNIT SDK package is published.
| Snippet surface | Status | When to use |
|---|---|---|
| Endpoint snippets | Backed by OpenAPI metadata. | Quick endpoint-level tests and field discovery. |
| Workflow templates | Maintained with the docs source and validated in the docs test gate. | Copy-paste scan, resolve, review, apply integrations. |
| Official SDK package | Not published yet. | Will replace or wrap the workflow templates when available. |
Contract Policy#
| Policy | Current rule |
|---|---|
| Public route policy | Production API calls use bare routes on https://api.kernit.org. Do not prefix public calls with /api. |
| Auth policy | Document-processing routes use Bearer API keys. Dashboard and team-management routes can use browser session auth where documented. |
| DOCX size ceiling | 25 MB |
| Support context | endpoint, status, requestId, scanFingerprint, settingsHash |
Variant Model#
KERNIT docs currently publish one live API contract. Future enterprise, async-job, or resolver-specific contracts should appear as separate version or variant entries in this page before they become integration requirements.