Toast
API Reference

Collaboration

Real-time collaboration and AI features powered by Tiptap Cloud.

POST
/api/collaboration/token

Generates a JWT for Tiptap Cloud collaboration on a specific document.

Request Body

application/json
  1. body
contentId*string

Content item to collaborate on

Formatuuid

Response Body

Collaboration token generated

application/json
  1. response
token*string

JWT token

documentName*string

Document name in format siteId:contentId

appId*string
expiresAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/collaboration/token' \  -H 'Content-Type: application/json' \  -d '{  "contentId": "21aa1683-ca25-4edf-bc18-01ad04a4821b"}'
Example Response
{  "token": "string",  "documentName": "string",  "appId": "string",  "expiresAt": "2019-08-24T14:15:22Z"}

Generate AI token

POST
/api/collaboration/ai/token

Generates a JWT for Tiptap AI features.

Response Body

AI token generated

application/json
  1. response
token*string
appId*string
expiresAt*string
Formatdate-time
Example Request
curl -X POST 'https://example.com/api/collaboration/ai/token'
Example Response
{  "token": "string",  "appId": "string",  "expiresAt": "2019-08-24T14:15:22Z"}