Developers · API
APIs: inside documents, and around them.
There are two programming surfaces today: the Runtime API that a document uses inside a reader, and a connector that lets AI assistants work with a user’s IDOP Cloud. A general public HTTP API is planned, not built.
§ 01Runtime API
globalThis.idop
Available
idop.runtime.getInfo()
idop.storage.read(path) idop.storage.write(path, text)
idop.storage.delete(path) idop.storage.list()
idop.storage.transaction(operations)
idop.network.request({ capability, url, method, headers, body })
idop.env.get(id)
idop.ui.requestSave() idop.ui.requestConfiguration()
idop.host.getInputFile() idop.host.putOutputFile(bytes)Every method returns a promise. Failures reject with an error whose code is stable — branch on it, never on the message. The complete reference, with every error code, is in §11 and §16 of the specification.
§ 02Connector for AI assistants
An MCP server that acts only as the user.
It lets assistants such as Claude and ChatGPT create, read, update and share documents in a user’s IDOP Cloud — after the user signs in and approves the connection.
Preview
| Tool | Kind | What it does |
|---|---|---|
get_authoring_guide | read | The rules for a valid IDOP 1.0 document |
list_files · search_files | read | Browse and find files in the user’s IDOP Cloud |
read_document | read | What a document is, and the data saved inside it |
validate_document | read | Check sources without saving |
create_document | write | Pack sources into a validated .idop and save it |
update_document_data | write · destructive | Change storage/ as a new revision |
create_share_link | write · open world | A link with an expiry and an optional password |
delete_file | write · destructive | Delete one file |
- OAuth 2.1 sign-in; the connector holds no service key and acts with the user’s own permissions.
- Every document an assistant writes is validated by the same core as the reader before it is saved.
- The user can withdraw the connection at any time.
The connector is built and tested, and is being prepared for the official assistant directories. Its public address will be published here when it is available.
§ 03Public HTTP API
Planned.
Planned
Programmatic access to IDOP Cloud beyond the assistant connector — for integrations, automation and other readers — is planned. No endpoints are published, and none of the examples on this site call one.
If you need one, tell us what for: it will shape what we build. Contact.
Use the Runtime API.
The examples show storage, network access with a credential, and viewers for ordinary files.