api-guide.idop
Interactive documentation
Documentation whose examples can be run and changed in place, shipped as one versioned file.
Solutions · Developers
Ship a tool as a single file.
If you build small interactive tools, IDOP gives them a distribution format: web code in a validated package that people can open without installing anything, and that cannot reach the network unless they agree.
§ 01The problem
What tends to go wrong today.
- A useful internal tool needs hosting, a domain, authentication and maintenance — for twenty users.
- Sending HTML files around means sending code that can do anything a web page can.
- There is no standard place to keep a small tool’s state other than a server or local storage.
§ 02Where IDOP fits
What the format changes.
Web code, unchanged
HTML, CSS and JavaScript under code/. No framework is required or forbidden.
A small Runtime API
Storage, permissioned network requests, configuration and save — and nothing else.
A contract with the reader
Stable error codes, a JSON Schema for the manifest, and conformance rules every reader follows.
§ 03Honestly
What exists today — and what does not.
Available today
- The IDOP 1.0 specification and JSON Schemas
- A self-contained prompt for writing documents with any AI model
- IDOP Cloud as a reader for testing and sharing
Not yet
- A public release of the command-line validator (preview)
- SDKs for other languages (planned)
- A public HTTP API (planned)
§ 04Examples
Documents of this kind.
renal-dosing.idop
Clinical calculator
A scoring or dosing formula that carries its own references and versioned logic, so the calculation a reviewer approved is the one that runs. Illustration only — not medical software.
survey-explorer.idop
Data exploration tool
A dataset with its own filters and views, so the reader explores the data rather than a screenshot of it.
site-inspection.idop
Form and workflow
A multi-step form with its validation built in, filled in offline and returned as the same file.
Open your first IDOP document
IDOP Cloud runs in the browser. Start from a template, open a file you were sent, or keep your own — no installation, and no account needed just to open a document.