Mint a read-only realtime ticket for a shared item
Issues a short-lived, single-use ticket that lets the holder of a share link open a receive-only realtime connection for that item, so the page reflects edits without reloading. Requires the admitted-session grant returned by a consuming public read; reconnects reuse that grant without claiming another use. The path token alone is insufficient, and the response carries an opaque channel id rather than the token itself. A revoked, expired, or non-surface token returns the same opaque not-found.
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/v1/public/shares/string/realtime-ticket" \ -H "Content-Type: application/json" \ -d '{ "grant": "string" }'{ "data": { "ticket": "string", "expiresAt": "string", "workspaceId": "string", "channel": "string", "surfaceId": "string", "updateMode": "snapshot", "showEditorPresence": true }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Resolve a public share token to its read-only payload
Atomically claims one use of the token and returns a read-only render of the shared item: a surface's manifest and blocks, or a file's name, type, size, and inline capability URL, each with a minimal meta block carrying the title, access level, and workspace name. Surface responses also return a short-lived viewerGrant for realtime ticket minting and reconnects; the grant does not claim additional uses. No authentication; the share token in the path is the credential. A revoked, expired, or use-exhausted token — and an item that is archived or not publicly renderable — all return the same opaque not-found response.
Comment on a shared page through a share link
Adds a comment to one block of a shared page or note on behalf of an anonymous guest, attributed with the optional `guestName`; the block must belong to the shared surface and the body is trimmed to 4000 characters. Resolving the link here does not consume a use, so commenting is repeatable. No authentication; the share token in the path is the credential, and it must grant comment or edit access — anything else returns the same opaque not-found response.