Do API calls use /api/ in production?

No. Public production calls use bare routes on https://api.kernit.org, for example /hyperlink-scan. The internal Cloudflare Pages function path remains implementation detail.

Which endpoint should I start with?

Use /hyperlink-scan, then /hyperlink-crossref when DOI evidence is needed, then /hyperlink-apply. Use /hyperlink only for one-step workflows that do not require review.

Does KERNIT store my DOCX?

The API processes uploaded DOCX files to return review data or a linked DOCX. Team and billing metadata are stored for account operations, but docs should be treated as request payloads, not durable project files.

KERNIT Documentation

KERNIT API Documentation

The KERNIT API exposes the Hyperlinker as a reviewable document-processing pipeline: scan a DOCX, resolve reference evidence, submit review decisions, and receive an editable linked DOCX.

Base URL#

https://api.kernit.org

Production API endpoints are bare routes on api.kernit.org. Do not prefix public production calls with /api.

POST /hyperlink-scan

Scan first, write later#

Start every reviewable integration by collecting matches, targets, scanFingerprint, and scanToken without changing the uploaded DOCX.

AuthBearer API key BillingUsually free or included review preparation Hosthttps://api.kernit.org

Endpoint Map#

Method	Endpoint	Purpose
POST	`/hyperlink-scan`	Scan a DOCX for reviewable links
POST	`/hyperlink-crossref`	Resolve bibliography entries with Crossref evidence
POST	`/hyperlink-apply`	Apply reviewed links to a DOCX
POST	`/hyperlink`	One-step DOCX hyperlinking
GET	`/api-keys`	List individual API keys
POST	`/api-keys`	Create an individual API key
DELETE	`/api-keys`	Revoke an individual API key
GET	`/org-keys`	List organization API keys
POST	`/org-keys`	Create organization API key
DELETE	`/org-keys`	Revoke organization API key
GET	`/org-presets`	List shared organization presets
POST	`/org-presets`	Create shared organization preset
GET	`/org-usage`	List organization usage
GET	`/admin-docs-insights`	Get hosted docs analytics summary

Recommended Integration#

Use the three-step flow for most production integrations: scan, resolve, then apply. It gives your product a review checkpoint before KERNIT writes links into the DOCX.

Workflow guideFull scan, resolve, review, apply payloads. NodeComplete script that writes a linked DOCX. Pythonrequests-based integration with final file output. cURLShell workflow for debugging every request.

Schema-first Reference#

The public schema is available at /docs/openapi.json. Endpoint pages read from the same source file, app/docs/openapi.json, so request fields and response contracts have one maintenance surface.

Response Contract Pattern#

Scan state

{
  "scanFingerprint": "sha256:...",
  "scanToken": "eyJ...",
  "matches": [],
  "targets": []
}

Final output

{
  "docx": "base64-encoded-docx",
  "linkCount": 47,
  "statCounts": { "cite": 23, "fig": 6, "tbl": 8 }
}

FAQ

Do API calls use /api/ in production?: No. Public production calls use bare routes on https://api.kernit.org, for example /hyperlink-scan. The internal Cloudflare Pages function path remains implementation detail.
Which endpoint should I start with?: Use /hyperlink-scan, then /hyperlink-crossref when DOI evidence is needed, then /hyperlink-apply. Use /hyperlink only for one-step workflows that do not require review.
Does KERNIT store my DOCX?: The API processes uploaded DOCX files to return review data or a linked DOCX. Team and billing metadata are stored for account operations, but docs should be treated as request payloads, not durable project files.

Was this page useful?Send a lightweight docs feedback event.

Last updated: May 12, 2026Canonical: https://kernit.org/docs/api/