The API

The same REST API the editor uses, callable from your own scripts with an API token.

Applies To

Every liveworkspace app

The base URL

The API lives under /api on your liveknowledge host. On the hosted service that is:

Authenticating in one line

Send an API token as a bearer header on each request:

API tokens are a signed-in-only feature. Authentication covers how to create one and how token access compares to the guest path.

What you can do

The token-callable surface mirrors the app:

The full reference

Point Postman, an OpenAPI viewer, or a client generator at that URL to explore the whole surface or scaffold a client. Endpoints an external token can use are tagged x-token-usable.

The realtime collaboration WebSocket is not part of the REST reference. The OpenAPI reference lists the upgrade endpoint, but the live message protocol is intentionally separate.

How this works in 5 other apps

Was this article helpful?

Still need help?

Try Troubleshooting, or tell us what you were trying to do.

Contact us