---
title: "Redeem a ticket for a workbench session: the person's editor on that one document. The ticket is the credential."
method: POST
path: "/workbench/sessions"
tags: ["Workbench"]
---

# Redeem a ticket for a workbench session: the person's editor on that one document. The ticket is the credential.

`POST /workbench/sessions`

## Request

- Base URL: `https://www.livediagram.app/api`
- URL: `https://www.livediagram.app/api/workbench/sessions`
- Auth: none required

## Request body

- WorkbenchSessionRequest
  - `ticket` string, required

## Response `201`

Success.

- WorkbenchSessionResponse
  - `documentId` string, required
  - `expiresAt` number, required
  - `origin` string, required
  - `person` WorkbenchPerson, required
    - `color` string, nullable, required
    - `id` string, required
    - `name` string, nullable, required
    - `pictureUrl` string, nullable, required
  - `role` 'view' | 'participate' | 'edit', required
  - `session` string, required
  - `tabId` string, nullable, required

## Other responses

- `400`: Error.
- `401`: Error.
- `404`: Error.
- `410`: Error.
- `429`: 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)
