Excalidraw+ API

Share presentation slides

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.

Each frame in the scene is one slide. Turning sharing on fails with 400 when the scene has no frames.

Turning sharing on fails with 403 when a workspace admin has disabled scene sharing for the workspace.

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

Authorization

apiKey
headerAuthorizationBearer <Bearer>

The API will use the Authorization: Bearer <your-key> header for requests.

Path Parameters

sceneId*string

Request Body

application/json
  1. body
enabled*boolean

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

Response Body

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

application/json
  1. response

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

enabled*boolean
url*|

The link to the shared slides, or null when sharing is off.

Example Request
curl -X PUT 'https://api.excalidraw.com/api/v1/scenes/string/shared-slides' \
  -H 'Content-Type: application/json' \
  -d '{
  "enabled": true
}'
Example Response
{
  "enabled": true,
  "url": "string"
}

Last updated on