Skip to main content
SuperDocs home page
Search...
⌘K
v1
POST
Edit, draft, or restructure a document using natural language. Preserves tables, styling, and formatting.
GET
List your active document editing sessions to resume or audit prior work.
GET
Restore the full conversation and document state for a previous session.
POST
Upload Attachment
DEL
Remove an attachment from a session or cancel its in-progress processing.
GET
Check processing status of all attachments in a session.
POST
Upload Document To Editor
POST
Export the current document as a styled .doc, .docx, .pdf, or .html file with full fidelity.
POST
Upload .docx/PDF/HTML/MD/RTF as the active editable document with chunk-ID structural editing.
POST
Upload a reference file (PDF/DOCX/image) for the AI to query while editing.
POST
Save a document template (NDA, contract, SOP, letterhead) for reuse across sessions.
GET
List your async chat jobs (in-progress, awaiting approval, completed, failed).
GET
Get the status, partial results, and any pending changes for an async chat job.
POST
Cancel a pending or in-progress async chat job.
GET
List all async chat jobs for a specific session, most recent first.
POST
Start a long-running or HITL-approved AI edit; returns a job_id to poll for results.
GET
Stream Chat Progress
POST
Approve or deny AI-proposed document changes one-by-one or in batch (HITL workflow).
GET
Poll Session Updates
POST
Upload User Template
GET
List all saved document templates available to the user or organization.
DEL
Delete a saved document template by ID.
users
GET
Get Current User Profile
PATCH
Update User Profile
GET
Get User Usage Stats
GET
Get User Sessions
DEL
Delete User Session
GET
Check User Limits
GET
List Api Keys
POST
Create Api Key
DEL
Revoke Api Key
billing
POST
Create Checkout
GET
Get Portal
POST
Cancel Subscription Endpoint
promo
POST
Redeem Promo
GET
List My Promotions
uploads
POST
Get a pre-signed URL to upload large files (.docx/PDF/HTML/MD/RTF) without bloating agent context.
POST
Parse an uploaded file into structured HTML with chunk IDs for targeted AI editing.
POST
Get a pre-signed URL to download an exported document without proxying through the agent.
API Reference
GET
Root
GET
Health Check Deep
GET
Oauth Protected Resource
GET
Oauth Protected Resource
GET
Oauth Protected Resource
GET
Oauth Authorization Server
GET
Oauth Authorization Server
GET
Oauth Authorization Server
GET
Openid Configuration
GET
Openid Configuration
GET
Openid Configuration
mcp
GET
Verify the SuperDocs MCP server is reachable and serving traffic.
SuperDocs home page
Search...
⌘K
Search...
Navigation
API Reference
Root
Documentation
API Reference
Documentation
API Reference
API Reference
Root
GET
Try it
Root
cURL
curl
--request
GET
\
--url
https://api.example.com/
Response
200 - application/json
Successful Response
Previous
Health Check Deep
Deep health check that verifies the job queue, AI workflow state store, and database are all responsive within a bounded time budget. Used by container orchestrators as a liveness probe to distinguish "process alive and TCP listening" (what /health reports) from "application is actually serving requests" (this endpoint).
Next
⌘I
Root
cURL
curl
--request
GET
\
--url
https://api.example.com/