# Create Image — Mural

> 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…

- Key: `mural-create-image`
- Type: Action (Write)
- Version: 0.0.2
- App: Mural (`mural`) — https://pipedream.com/apps/mural.md
- This page (HTML): https://pipedream.com/apps/mural/actions/create-image
- Hints: open-world
- Source: https://github.com/PipedreamHQ/pipedream/blob/master/components/mural/actions/create-image/create-image.mjs

## Description

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](https://developers.mural.co/public/reference/createimage)

## Props

| Prop | Type | Required | Description |
|---|---|---|---|
| `workspaceId` | `string` | Yes | The ID of the Workspace. Options are loaded from the connected account. |
| `muralId` | `string` | Yes | The ID of the Mural. Options are loaded from the connected account. |
| `filePath` | `string` | Yes | 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. |
| `syncDir` | `dir` | No | SyncDir |
| `xPosition` | `integer` | Yes | 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. |
| `yPosition` | `integer` | Yes | 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. |
| `width` | `integer` | Yes | The width of the widget in px (e.g. 500) |
| `height` | `integer` | Yes | The height of the widget in px (e.g. 300) |
| `caption` | `string` | No | The caption and outline title of the image widget |
| `description` | `string` | No | The caption description text of the image widget |
| `border` | `boolean` | No | If true, a black border is displayed around the widget |
| `showCaption` | `boolean` | No | When true, captions will be displayed for the image widget |
| `hidden` | `boolean` | No | If true, the widget is hidden from non-facilitators. Applies only when the widget is in the outline |
| `parentId` | `string` | No | 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. Options are loaded from the connected account. |

## Run it

**MCP**

```ts
import { Client } from "@modelcontextprotocol/sdk/client/index.js"
import { StreamableHTTPClientTransport } from "@modelcontextprotocol/sdk/client/streamableHttp.js"
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 accessToken = await pd.rawAccessToken

const transport = new StreamableHTTPClientTransport(
  new URL("https://remote.mcp.pipedream.net/v3"),
  {
    requestInit: {
      headers: {
        Authorization: `Bearer ${accessToken}`,
        "x-pd-project-id": process.env.PIPEDREAM_PROJECT_ID!,
        "x-pd-environment": "production",
        "x-pd-external-user-id": "{external_user_id}", // any stable ID for this user in your system
        "x-pd-app-slug": "mural",
      },
    },
  },
)

const mcp = new Client({ name: "my-agent", version: "1.0.0" })
await mcp.connect(transport)

const { tools } = await mcp.listTools()

// listTools() hands your model this tool's input schema, so it can
// fill the arguments itself:
const result = await mcp.callTool({
  name: "mural-create-image",
  arguments: {
    workspaceId: "Workspace ID",
    muralId: "Mural ID",
  },
})
```

**TypeScript**

```ts
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)
```

**cURL**

```bash
curl -X POST https://api.pipedream.com/v1/connect/{project_id}/actions/run \
  -H "Content-Type: application/json" \
  -H "X-PD-Environment: production" \
  -H "Authorization: Bearer {access_token}" \
  -d '{
    "external_user_id": "{external_user_id}",
    "id": "mural-create-image",
    "configured_props": {
      "mural": { "authProvisionId": "apn_xxxxxxx" },
      "workspaceId": "Workspace ID",
      "muralId": "Mural ID"
    }
  }'
```

---

- App: https://pipedream.com/apps/mural.md · All apps: https://pipedream.com/apps