Skip to main content
POST
A token for real-time co-editing on Doconda's server: your backend asks for it, the editor connects with it (`collab.token`)

Authorizations

Authorization
string
header
required

Authorization: Bearer ak_eu_…, a key from the dashboard (API keys).

Body

application/json
room
string
required

Your id for the document: everyone with a token for the same room edits it together.

Required string length: 1 - 200
Pattern: ^[\w.:-]+$
audience
enum<string>

browser (default): for the editor in a page, from the licence's domains. server: for a program with no Origin, such as exportRoom in @doconda/editor/server; keep it on your server.

Available options:
browser,
server

Response

Signed token for that room.

token
string
required

Give it to the editor (collab.token). It only lets the editor join this room, from one of the licence's domains (with audience: "server", also from a program with no Origin), for 10 minutes; a connection already open stays open.

expires_at
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$