An API token lets your own scripts and integrations talk to the liveknowledge API as you, outside the editor. Tokens belong to your liveworkspace account, so one token works with the API of every liveworkspace app, liveknowledge included. A token carries your account's full read and write access unless you make it read-only, so treat it like a password.
You need an account
API tokens are a signed-in-only feature. The editor, sharing, and real-time collaboration all stay account-free for guests, but tokens require signing in, the same as teams.
Creating a token
In liveknowledge, open Settings (the sliders icon near the end of the bottom bar), choose Developers, then API Tokens, and make the token right there. The same list of tokens is in every liveworkspace app's Settings and on liveworkspace.app.
Name the token, switch on Read-only if it only needs to look, and create it. Its secret is shown once, right after you create it: copy it then, because it is never displayed again. If you lose the secret, revoke the token and create a new one.
What a token can do, and for how long
- Access: a token has your account's read + write access to knowledgebases and folders, including your teams' shared libraries, or read access only if it is read-only. It can't manage teams or your account: those are done on liveworkspace.app, signed in.
- Lifetime: every token lasts six months, then expires. Rotate by creating a fresh token before the old one lapses.
- Limit: you can have up to 20 tokens at once, across every liveworkspace app. Revoke one to free a slot.
Using a token
Send the token as a bearer header to the API, which lives under /api on your liveknowledge host (https://www.liveknowledge.app/api on the hosted service). Here is a call that lists your work:
Every request authenticated this way acts as your account, with the same read and write access you have in the editor. A few rules are particular to tokens: edits go through changesets rather than whole-tab saves, a token can't delete a knowledgebase's last tab, and each token has its own rate limits. Keep the Authorization header on each request; there is no separate login step.
For what you can call and how, see the Developers section: Authentication, worked examples, and errors and rate limits. The full machine-readable reference is published at /api/openapi.json.
Viewing and revoking tokens
Your tokens are listed in the same place (Settings, Developers, API Tokens, in any liveworkspace app or on liveworkspace.app), with when each was created, last used and expires. Revoke one there. liveknowledge stops accepting it within a minute. Deleting your account also removes all of your tokens, along with the rest of your data.
Keep tokens out of source control and shared logs. If one might have leaked, revoke it and create a replacement, no need to change anything else about your account.
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.