Mint an embed session for one document

Mint an embed session for one document - POST /embed/sessions. DocDealer REST API reference.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

displayName*string

Name shown in collaboration presence and edit attribution. Signed into the token, so the embedded browser cannot change it.

Length1 <= length <= 120

documentId*string

externalUserId?string

Stable id for the end user in the wrapper app. Namespaces the synthetic collab user id so presence and cursor colours stay consistent across reloads. Defaults to a slug of displayName.

Length1 <= length <= 200

parentOrigin?string

Origin of the page that will host the iframe. Enables postMessage token refresh; the iframe accepts messages from this origin only. Omit to disable the bridge.

theme?string

Initial colour theme for the embedded editor, so it matches the host page on first paint. Appended to the returned URL rather than signed into the token — it carries no security weight, and keeping it out means the host can change it (or override it live over postMessage) without minting a new session.

Value in

"light"
"dark"

ttlSeconds?integer

Token lifetime. Defaults to EMBED_TOKEN_TTL_SECONDS (900).

Range60 <= value <= 43200

Response Body

`application/json`

curl -X POST "https://example.com/embed/sessions" \  -H "Content-Type: application/json" \  -d '{    "displayName": "string",    "documentId": "string"  }'

{  "expiresAt": "string",  "token": "string",  "url": "string"}

Mint an embed session for one document

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`