EXexcalidraw
collections
scenes

Create scene in collection

Changed on

Create a new scene within a specific collection.

This endpoint creates a scene with the specified metadata and assigns it to the given collection.

**Use cases:**
- Adding new scenes to a project or team collection
- Automating scene creation for workflows
- Integrating with external tools to populate collections
post/api/v1/collections/{collectionId}/scenes

Request

  • Base URL
    https://api.excalidraw.com
  • URL
    https://api.excalidraw.com/api/v1/collections/{collectionId}/scenes
  • Auth
    HTTP bearer

Path parameters

collectionIdstring required

Collection ID. Personal API keys may use 'private' for the key owner's virtual private collection. Workspace API keys cannot access private collections.

Request body

namestring required
pinnedboolean

Pin the scene in the collection. Default: false.

Response

This response returns the details of the newly created scene.

Changes

  • 8a929c8cc5f5Revision changes
    • info

      the request property became optional

  • 9eecb866ae18Revision changes
    • breaking

      the response property // became nullable for the status

    • breaking

      the response property // became nullable for the status