Careers InboxDocs

Reference

API reference

Every endpoint, and which need a session.

Every HTTP endpoint of the app, read from its route files. Session means the request needs a signed-in session (the deployment passcode, or the app's own sign-in); Public endpoints answer anyone.

Note

Requests that change data must come from the app's own pages; send JSON unless an endpoint says otherwise.

/api/applications

Method Path Access What it does
GET /api/applications Session —
PATCH /api/applications/:id Session —
DELETE /api/applications/:id Session —
GET /api/applications/:id/files/:fileId Session Resumes are personal data: only an unlocked inbox session can download them.
GET /api/applications/export Session —

/api/domains

Method Path Access What it does
GET /api/domains Session —
POST /api/domains Session —
PATCH /api/domains/:id Session —
DELETE /api/domains/:id Session —
POST /api/domains/:id/verify Session Loads the domain's home page and looks for its site key. Next.js serializes <Script> props into the HTML, so the key is present even for client-loaded scripts.

/api/edit-auth

Method Path Access What it does
GET /api/edit-auth Session —
POST /api/edit-auth Session —
DELETE /api/edit-auth Session —

/api/items

Method Path Access What it does
GET /api/items Public Inventory endpoint read by subdomains.appneural.com. Applications are private, so the public inventory is the set of connected domains, without names, keys or counts.

/api/provision

Method Path Access What it does
GET /api/provision/nextjs Public The site key is public by design (it ships in every page's HTML), so this needs no session.

/api/submit

Method Path Access What it does
OPTIONS /api/submit Public —
POST /api/submit Public —
GET /api/submit Public —

Other routes

Method Path Access What it does
GET /health Public Liveness and database check. The System Registry lists https://<host>/health for every catalog.

Pages in the app

Page What it shows
/ —
/domains —
/setup —
Last updated 2 November 2026