---
title: "Mint a one-time ticket for opening the realtime room: pass it to the WebSocket upgrade as `?t=`. Same access policy as a read, share password included. Exempt from the write rate limit."
method: POST
path: "/documents/{id}/room-ticket"
tags: ["Documents"]
---

# Mint a one-time ticket for opening the realtime room: pass it to the WebSocket upgrade as \`?t=\`. Same access policy as a read, share password included. Exempt from the write rate limit.

`POST /documents/{id}/room-ticket`

## Request

- Base URL: `https://www.livediagram.app/api`
- URL: `https://www.livediagram.app/api/documents/{id}/room-ticket`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Owner-Id`

## Path parameters

- `id` string, required

## Response `200`

Success.

- object
  - `ticket` string, required

## Other responses

- `404`: Error.
- `410`: Error.

---

[API](https://skmtc.dev/livediagram/apis/livediagram-api.md) · [All operations](https://skmtc.dev/livediagram/apis/livediagram-api/llms.txt) · [OpenAPI document](https://skmtc.dev/livediagram/apis/livediagram-api/revisions/f286d27acfd2?raw)