Get a collaboration WebSocket token | Docmost Octri Preview

2 status codes

200Returns a response containing a collaboration token for WebSocket authentication.

dataunknownoptional

Response payload

statusintegeroptional

successbooleanoptional

401Returned when the request is unauthorized.

errorstringoptional

Reason phrase, for example `Bad Request`.

messagestringoptional

statusCodeintegeroptional

Error handling

A 401 is returned when the request is unauthorized. Provide valid authentication for the authenticated user.

import { DocmostAPIUnofficialOctriFullPreview } from "docmost-octri-preview-sdk";

const client = new DocmostAPIUnofficialOctriFullPreview({
  baseUrl: "{baseUrl}/api",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.auth.collabToken();

{
  "data": "example_value",
  "status": 200,
  "success": true
}

Response

Errors