Excalidraw+ API

Get scene content

Retrieve the complete content of a scene including all drawing elements and files.

This endpoint returns:

  • All drawing elements (shapes, lines, text, etc.)
  • Embedded files and images
  • Scene settings and configuration
  • Version information
  • Canvas state and viewport settings

The response includes the current version of the scene. For version history or specific versions, use the versioning endpoints.

Large scenes with many elements or files may result in substantial response sizes. Consider implementing client-side caching for frequently accessed scenes.

Use cases:

  • Loading scenes for editing
  • Creating scene backups
  • Exporting scene data
  • Scene analysis and processing
GET
/api/v1/scenes/{sceneId}/content

Authorization

apiKey
headerAuthorizationBearer <Bearer>

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

Path Parameters

sceneId*string

Response Body

This response returns the complete content of the requested scene.

application/json
  1. response

This response returns the complete content of the requested scene.

type*"excalidraw"
Value in"excalidraw"
version*number
source*string
appState*
elements*array<unknown>
sceneVersion*string
files*
filesFailedToEmbed?array<string>

List of file IDs referenced by the scene that could not be embedded into the response. Omitted when all referenced files were embedded successfully.

Example Request
curl -X GET 'https://api.excalidraw.com/api/v1/scenes/string/content'
Example Response
{
  "type": "excalidraw",
  "version": 0,
  "source": "string",
  "appState": {
    "viewBackgroundColor": "string",
    "lockedMultiSelections": {
      "property1": true,
      "property2": true
    }
  },
  "elements": [
    null
  ],
  "sceneVersion": "string",
  "files": {
    "property1": {
      "mimeType": "string",
      "id": "string",
      "created": 1,
      "lastRetrieved": 1,
      "version": 1,
      "dataURL": "string"
    },
    "property2": {
      "mimeType": "string",
      "id": "string",
      "created": 1,
      "lastRetrieved": 1,
      "version": 1,
      "dataURL": "string"
    }
  },
  "filesFailedToEmbed": [
    "string"
  ]
}

Last updated on