Get started
O3O Office Online API documentation
Run O3O Office Online with Docker on your own server, embed the editor in a web application, connect it to Nextcloud and call the DocBuilder REST API to convert or generate documents.
On this page
O3O Office Online is a browser-based word processor, spreadsheet and presentation editor that you install on your own server. This documentation is for developers and system administrators: running the Docker stack, embedding the editor, connecting a storage system and calling the document-processing API.
The three parts you will use#
| Component | Main job | Path through the proxy |
|---|---|---|
Collaborative editor (o3o-online) | Opens and edits .docx, .xlsx, .pptx, .odt and more in the browser, with several people editing one file. | /browser, /cool, /hosting |
Control service (o3o-gate) | Counts editing sessions and enforces the plan's connection limit, reads the license token, provides the O3O.Editor embedding layer and the internal WOPI host. | /o3o/ |
DocBuilder (o3o-docbuilder) | Browser-less REST API: format conversion, building documents from o3oscript scripts, template filling, text, metadata and thumbnail extraction. | /v1/ |
Documentation sections#
Quick startRun the Docker stack, open the editor and convert a file to PDF.Editor embeddingO3O.Editor: configuration, events, methods, JWT and save callbacks.Storage integrationNextcloud and your own WOPI host.O3O DocBuilder and conversionConversion, o3oscript scripts, templates, extraction, asynchronous jobs.PlatformPlans, connection counting, license tokens, authentication, error codes.Self-hostingEnvironment variables, proxy, TLS, upgrades and troubleshooting.ReferenceQuick lookup of endpoints, schemas and terms.
Where to start#
| You are | Read first |
|---|---|
| A system administrator trying it on your own machine | Quick start, then Architecture and components |
| An organisation already running Nextcloud | Choosing an integration, Nextcloud section |
| A web developer who wants documents to open inside your application | Choosing an integration, O3O.Editor embedding section |
| A system that only needs automated conversion or generation | Choosing an integration, DocBuilder-only section |
| A buyer or budget owner | Editions and feature differences |
What v1 includes#
- A DEV Docker stack started with one
docker composecommand: proxy, editing server, o3o-gate, DocBuilder, plus an optionalnextcloudprofile. - Concurrent editing sessions are counted and capped per plan; open sessions are never cut off and saves are never blocked.
- The
O3O.Editorembedding layer with 7 events and 5 methods, JWT HS256 signed configuration and HMAC SHA-256 signed save callbacks. - DocBuilder with 11 endpoints: conversion, o3oscript for text documents, spreadsheets and presentations,
{{field}}template filling with table row repetition, text, metadata and thumbnail extraction. - Ed25519 license tokens verified offline for the enterprise edition.
Coming soon
An O3O Office Online image built from source (the release build), white-labelling for the enterprise edition, online license activation and renewal, language SDKs, version history in the embedding layer, charts in o3oscript, Prometheus metrics.
Conventions#
- The sample server in every example is
http://localhost:8080, the proxy of the Docker stack on your machine. - The sample DocBuilder key is kept in the
O3O_DEMO_KEYenvironment variable. Replace it with a real key from the server'sO3O_DOCBUILDER_API_KEYS. - Beta label: works but may change. Coming soon label: not part of v1, do not plan a rollout around it.
- The Community and Enterprise labels on each endpoint show which edition can call it.
- Performance figures (processing time, requests per second, memory) are not measured yet; the documentation gives no committed numbers until real measurements exist.