scenes

Share presentation slides

Changed on

Turn the scene's shared presentation link on or off and return the link.

Anyone with the link can step through the scene's frames as slides without signing in. The link is created the first time sharing is turned on and stays the same when it is turned off and on again.

<Callout type="info">
Each frame in the scene is one slide. Turning sharing on fails with 400 when the scene has no frames.
</Callout>

<Callout type="warn">
Turning sharing on fails with 403 when a workspace admin has disabled scene sharing for the workspace.
</Callout>

**Use cases:**
- Sending a presentation to an audience
- Publishing slides alongside a talk
- Revoking access to shared slides
put/api/v1/scenes/{sceneId}/shared-slides

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/scenes/{sceneId}/shared-slides
  • Auth
    HTTP bearer

Path parameters

sceneIdstring required

Request body

enabledboolean required

true to share the slides, false to turn the link off.

Response

This response returns whether the slides are shared, and their link.

enabledboolean required
urlunknown required

Changes