API reference
Every programmable surface of paged in one place — the paged.* scripting API, the Viewer SDK, the editor-server REST API, and the plugin manifest — each generated from its own source of truth.
In short paged exposes four programmable surfaces. Each reference below is generated from its own source of truth — the engine's scripting catalog, the SDK package surface, the server's OpenAPI spec, and the plugin manifest schema — so none of them drift from the running code.
The Boa host API for inspecting and authoring the open document — every function and settable path, generated from the engine catalog.
The full @paged-media/idml-viewer surface — viewer lifecycle, camera, navigation, rendering, events, and every exported type.
The editor-server HTTP API — documents, assets, auth, and billing — generated from its OpenAPI spec.
The declarative contract a plugin bundle ships — capabilities, contributions, and manifest fields.
Which one do I want?
- Scripting (
paged.*)read and author the open document from inside the editor's script panel, the REPL, or headless viapaged-run. Start with the examples. - Viewer SDKembed a WebGPU IDML viewer on a canvas: load a document, drive the camera, render to bytes, listen for events.
- REST APIthe editor-server HTTP surface for accounts, document storage, billing, and assets.
- Plugin manifestthe declarative contract a plugin bundle ships to contribute tools, panels, commands, and document behaviour.
Versioning & compatibility
How the plugin API is versioned — apiVersion ranges and the 0.x caret rule, runtime capability detection with host.supports, the freeze policy for v1, and what plugin authors should pin.
REST API
The editor-server REST surface — authentication, files, account, billing, fonts, and image search — generated from the server's OpenAPI specification.