View as Markdown
Excalidraw icon

Excalidraw ACTION

Get Scene

Returns metadata for a specific Excalidraw scene, and optionally its full drawing content (elements JSON). Use this when the user asks to view, inspect, or read a specific scene. Use List Scenes first to find the scene ID by name. Set includeContent to true only when the user explicitly asks for the drawing data — the content can be large. See the documentation
  • Action
  • Read only
  • API key
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Excalidraw account once, then configure and run Get Scene from your backend or agent.

import { PipedreamClient } from "@pipedream/sdk"

const pd = new PipedreamClient({
  projectId: process.env.PIPEDREAM_PROJECT_ID!,
  clientId: process.env.PIPEDREAM_CLIENT_ID!,
  clientSecret: process.env.PIPEDREAM_CLIENT_SECRET!,
  projectEnvironment: "production",
})

const result = await pd.actions.run({
  id: "excalidraw-get-scene",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    excalidraw: { authProvisionId: "apn_xxxxxxx" },
    sceneId: "Scene ID",
    includeContent: true,
  },
})

console.log(result)

SCHEMA

Inputs

Pipedream supplies the connected account. Your application provides the operation-specific values below. Dynamic inputs are resolved against that user's account.

Get Scene inputs
Property Type Description
sceneId Scene ID string
The unique identifier of the scene. Use List Scenes to find scene IDs. Example: 4towcktqVl9.
Required
includeContent Include Drawing Content boolean
When true, also fetches the scene's drawing elements (the full canvas JSON). Only set this when the user explicitly asks for the drawing content.
Optional

REFERENCE

Tool details

Behavior hints are published with the component in the Pipedream registry and surface as MCP tool annotations, so an agent can reason about a tool before it calls it.

Registry key
excalidraw-get-scene
Version
0.0.2
App
Excalidraw
Authentication
API key
Read-only
Yes
Destructive
No
Open world
Yes