View as Markdown
Mural icon

Mural ACTION

Create Image

Upload an image and create an image widget on a mural. The image is uploaded to Mural's storage first and the widget is created from the uploaded asset, so the file must be reachable when the action runs. Only bmp, ico, gif, jpeg, jpg, png, and webp files are accepted; the format is detected from the file extension, falling back to the content type. See the documentation
  • Action
  • Writes data
  • OAuth
  • SDK
  • MCP

IMPLEMENTATION

Call this tool

Connect a user's Mural account once, then configure and run Create Image 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: "mural-create-image",
  externalUserId: "{external_user_id}", // any stable ID for this user in your system
  configuredProps: {
    mural: { authProvisionId: "apn_xxxxxxx" },
    workspaceId: "Workspace ID",
    muralId: "Mural ID",
  },
})

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.

Create Image inputs
Property Type Description
workspaceId Workspace ID string
The ID of the Workspace.
Required Dynamic
muralId Mural ID string
The ID of the Mural.
Required Dynamic
filePath File Path or URL string
The image to upload. Provide either a file URL or a path to a file in the /tmp directory (for example, /tmp/myImage.png). Supported formats: bmp, ico, gif, jpeg, jpg, png, webp.
Required
syncDir SyncDir dir
Optional
xPosition X Position integer
The horizontal position of the widget in px (e.g. 100). This is the distance from the left of the parent widget, such as an area. If the widget has no parent widget, this is the distance from the left of the mural.
Required
yPosition Y Position integer
The vertical position of the widget in px (e.g. 100). This is the distance from the top of the parent widget, such as an area. If the widget has no parent widget, this is the distance from the top of the mural.
Required
width Width integer
The width of the widget in px (e.g. 500)
Required
height Height integer
The height of the widget in px (e.g. 300)
Required
caption Caption string
The caption and outline title of the image widget
Optional
description Description string
The caption description text of the image widget
Optional
border Border boolean
If true, a black border is displayed around the widget
Optional
showCaption Show Caption boolean
When true, captions will be displayed for the image widget
Optional
hidden Hidden boolean
If true, the widget is hidden from non-facilitators. Applies only when the widget is in the outline
Optional
parentId Parent ID string
The ID of the area widget that should contain this image, for example 0-12345. When set, X Position and Y Position are measured from the area's top-left corner instead of the mural's.
Optional Dynamic

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
mural-create-image
Version
0.0.2
App
Mural
Authentication
OAuth
Read-only
No
Destructive
No
Open world
Yes