# Mural

Your Toolhouse AI Worker can connect to Mural using 22 specialized tools.

## Auth Connection

This service requires an auth connection to use its tools. You can set this up in your Toolhouse dashboard under [Auth Connections](https://toolhouse.app/auth-connections?authkit_slugs=mural).

## Tools (22)

### `Mural Authorization Request`

Integration name: **MURAL\_AUTHORIZATION\_REQUEST**

Tool to initiate the OAuth 2.0 authorization process. Use when you need to redirect a user to Mural to obtain an authorization code.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter       | Type   | Required | Example                                | Description                                                                                                               |
| --------------- | ------ | :------: | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `scope`         | array  |     ✅    | `["room:read","room:write"]`           | List of permission scopes to request. Provided as a list of strings; they will be joined with spaces in the URL.          |
| `state`         | string |          | `"xyz123"`                             | Optional opaque value sent and returned in the callback to prevent CSRF and correlate requests.                           |
| `client_id`     | string |     ✅    | `"my_client_id"`                       | The client identifier for your Mural app (provided when registering your app).                                            |
| `redirect_uri`  | string |     ✅    | `"https://example.com/oauth/callback"` | The callback URL where users are redirected after granting access. Must match one of your app's registered redirect URLs. |
| `response_type` | string |          | —                                      | Grant type for authorization code flow; must be 'code'.                                                                   |

### `Mural Create Sticky Note`

Integration name: **MURAL\_CREATE\_STICKY\_NOTE**

Create one or more sticky note widgets on a mural. Each sticky note must be a properly structured object with required x and y coordinates. Pass the 'stickies' parameter as a direct array of objects - NOT strings, NOT nested objects. Example usage: { "muralId": "mural-id-here", "stickies": \[ {"x": 100, "y": 200, "text": "First note"}, {"x": 300, "y": 400, "text": "Second note", "shape": "circle"} ] }

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter  | Type   | Required | Example | Description                                                                                                                                                         |
| ---------- | ------ | :------: | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `muralId`  | string |     ✅    | —       | Unique identifier of the mural                                                                                                                                      |
| `stickies` | array  |     ✅    | —       | Array of sticky note objects to create. Each object must have 'x' and 'y' coordinates. Pass objects directly, not strings or nested structures. Maximum 1000 items. |

### `Mural Get Current User`

Integration name: **MURAL\_GET\_CURRENT\_USER**

Tool to retrieve information about the currently authenticated user. Use when you need current user details after authentication.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

*No parameters required.*

### `Mural Get Files For Mural`

Integration name: **MURAL\_GET\_FILES\_FOR\_MURAL**

Tool to retrieve a list of file widgets in a mural. Use after confirming the mural ID when listing file attachments.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example      | Description                             |
| --------- | ------- | :------: | ------------ | --------------------------------------- |
| `next`    | string  |          | `"token123"` | Pagination token for next page of items |
| `limit`   | integer |          | `50`         | Maximum number of results to return     |
| `muralId` | string  |     ✅    | `"m12345"`   | Unique identifier of the mural          |

### `Mural Get Mural Widgets`

Integration name: **MURAL\_GET\_MURAL\_WIDGETS**

Tool to retrieve all widgets within a specified mural. Widgets include sticky notes, text boxes, shapes, images, areas, arrows, icons, files, and comments. Use this after obtaining a valid mural ID from workspace murals or other mural-related actions. Supports filtering by widget type, parent container, and pagination for large result sets.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter  | Type    | Required | Example            | Description                                                                                                 |
| ---------- | ------- | :------: | ------------------ | ----------------------------------------------------------------------------------------------------------- |
| `next`     | string  |          | `"abc123"`         | Pagination token from previous response to retrieve the next page of results.                               |
| `type`     | array   |          | `["area","arrow"]` | List of widget types to filter by (e.g., \['area', 'sticky note']). When omitted, returns all widget types. |
| `limit`    | integer |          | `50`               | Maximum number of widgets to return per page (must be ≥1). Use with 'next' for pagination.                  |
| `muralId`  | string  |     ✅    | `"mural123"`       | Unique identifier of the mural.                                                                             |
| `parentId` | string  |          | `"parent456"`      | Filter to return only widgets contained within the specified parent widget ID (typically an area widget).   |

### `Mural Get Room`

Integration name: **MURAL\_GET\_ROOM**

Tool to retrieve information about a specific room by its ID. Use when you need details about a particular room that the authenticated user has read access to.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example           | Description                               |
| --------- | ------ | :------: | ----------------- | ----------------------------------------- |
| `roomId`  | string |     ✅    | `"1747989311942"` | Unique identifier of the room to retrieve |

### `Mural Get Workspace`

Integration name: **MURAL\_GET\_WORKSPACE**

Tool to retrieve information about a specific workspace by its ID. Use when you need details about a particular workspace that the authenticated user has read access to.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type   | Required | Example           | Description                                    |
| ------------- | ------ | :------: | ----------------- | ---------------------------------------------- |
| `workspaceId` | string |     ✅    | `"workspace1234"` | Unique identifier of the workspace to retrieve |

### `Mural Get Workspaces`

Integration name: **MURAL\_GET\_WORKSPACES**

Tool to retrieve all workspaces the authenticated user is a member of. Use to list available workspaces before accessing rooms or murals.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example         | Description                                                  |
| --------- | ------- | :------: | --------------- | ------------------------------------------------------------ |
| `next`    | string  |          | `"abc123token"` | Pagination token for retrieving the next page of results     |
| `limit`   | integer |          | `50`            | Maximum number of workspaces to return per page (must be ≥1) |

### `Mural List Folders`

Integration name: **MURAL\_LIST\_FOLDERS**

Tool to list all folders within a room that the authenticated user has access to. Use after MURAL\_LIST\_ROOMS to navigate folders within a specific room.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example              | Description                                               |
| --------- | ------- | :------: | -------------------- | --------------------------------------------------------- |
| `next`    | string  |          | `"abc123token"`      | Pagination token for retrieving the next page of results  |
| `limit`   | integer |          | `50`                 | Maximum number of folders to return per page (must be ≥1) |
| `roomId`  | string  |     ✅    | `"1747989311942180"` | Unique identifier of the room to list folders from        |

### `Mural List Open Rooms`

Integration name: **MURAL\_LIST\_OPEN\_ROOMS**

Tool to list all discoverable open rooms within a workspace. Use when you need to access publicly available rooms in a workspace that don't require specific membership.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example          | Description                                                |
| ------------- | ------- | :------: | ---------------- | ---------------------------------------------------------- |
| `next`        | string  |          | `"abc123token"`  | Pagination token for retrieving the next page of results   |
| `limit`       | integer |          | `50`             | Maximum number of rooms to return per page (must be ≥1)    |
| `workspaceId` | string  |     ✅    | `"workspace123"` | Unique identifier of the workspace to list open rooms from |

### `Mural List Recent Murals`

Integration name: **MURAL\_LIST\_RECENT\_MURALS**

Tool to list recently opened active murals for the authenticated user in a workspace. Use after MURAL\_LIST\_WORKSPACES to view recent murals before opening or editing them.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example          | Description                                                   |
| ------------- | ------- | :------: | ---------------- | ------------------------------------------------------------- |
| `next`        | string  |          | `"abc123token"`  | Pagination token for retrieving the next page of results      |
| `limit`       | integer |          | `50`             | Maximum number of murals to return per page (must be ≥1)      |
| `workspaceId` | string  |     ✅    | `"workspace123"` | Unique identifier of the workspace to list recent murals from |

### `Mural List Recent Templates`

Integration name: **MURAL\_LIST\_RECENT\_TEMPLATES**

Tool to retrieve recent templates used by a user for a workspace. Use when you need to access recently used templates for creating new murals.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter        | Type    | Required | Example           | Description                                                                |
| ---------------- | ------- | :------: | ----------------- | -------------------------------------------------------------------------- |
| `next`           | string  |          | `"abc123token"`   | Pagination token for retrieving the next page of results                   |
| `limit`          | integer |          | `50`              | Maximum number of templates to return per page (must be ≥1)                |
| `workspaceId`    | string  |     ✅    | `"workspace1234"` | Unique identifier of the workspace to list recent templates from           |
| `withoutDefault` | boolean |          | `true`            | If true, the list of returned templates will not include default templates |

### `Mural List Room Murals`

Integration name: **MURAL\_LIST\_ROOM\_MURALS**

Tool to list all murals for a room that the authenticated user has read access to. Use after getting a room ID to retrieve murals within that room.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter  | Type    | Required | Example                              | Description                                              |
| ---------- | ------- | :------: | ------------------------------------ | -------------------------------------------------------- |
| `next`     | string  |          | `"abc123token"`                      | Token to get the next page of items                      |
| `limit`    | integer |          | `50`                                 | Maximum number of results to be returned by the endpoint |
| `roomId`   | integer |     ✅    | `1610033618903`                      | Unique identifier of the room to list murals from        |
| `sortBy`   | string  |          | `"lastCreated"`                      | Sort order options for murals.                           |
| `status`   | string  |          | `"active"`                           | Status filter for murals.                                |
| `folderId` | string  |          | `"29abcfdd-b9ba-4ced-aa27-00694889"` | When set, filter murals by their corresponding folder    |

### `Mural List Rooms`

Integration name: **MURAL\_LIST\_ROOMS**

Tool to list all rooms within a workspace. Use after MURAL\_LIST\_WORKSPACES to navigate rooms and before MURAL\_CREATE\_MURAL, since murals are created within rooms.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example          | Description                                              |
| ------------- | ------- | :------: | ---------------- | -------------------------------------------------------- |
| `next`        | string  |          | `"abc123token"`  | Pagination token for retrieving the next page of results |
| `limit`       | integer |          | `50`             | Maximum number of rooms to return per page (must be ≥1)  |
| `workspaceId` | string  |     ✅    | `"workspace123"` | Unique identifier of the workspace to list rooms from    |

### `Mural List Room Users`

Integration name: **MURAL\_LIST\_ROOM\_USERS**

Tool to list all members and guests for a room. Returns users that the authenticated user has access to view. Use after LIST\_ROOMS to get room membership details.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example              | Description                                              |
| --------- | ------- | :------: | -------------------- | -------------------------------------------------------- |
| `next`    | string  |          | `"abc123token"`      | Pagination token for retrieving the next page of results |
| `limit`   | integer |          | `50`                 | Maximum number of users to return per page (must be ≥1)  |
| `roomId`  | string  |     ✅    | `"1747989311942180"` | Unique identifier of the room to list users from         |

### `Mural List Tags`

Integration name: **MURAL\_LIST\_TAGS**

Tool to retrieve all tags in a mural. Use when you need to list or view tags associated with a specific mural.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type   | Required | Example                         | Description                  |
| --------- | ------ | :------: | ------------------------------- | ---------------------------- |
| `muralId` | string |     ✅    | `"workspace1234.1606743986126"` | Unique identifier of a mural |

### `Mural List Templates`

Integration name: **MURAL\_LIST\_TEMPLATES**

Tool to retrieve all default templates available in Mural. Use when you need to browse or select from standard Mural templates.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter | Type    | Required | Example         | Description                                                 |
| --------- | ------- | :------: | --------------- | ----------------------------------------------------------- |
| `next`    | string  |          | `"abc123token"` | Pagination token for retrieving the next page of results    |
| `limit`   | integer |          | `50`            | Maximum number of templates to return per page (must be ≥1) |

### `Mural List Workspace Murals`

Integration name: **MURAL\_LIST\_WORKSPACE\_MURALS**

Tool to list all murals in a workspace that the authenticated user owns or is a member of. Use after getting a workspace ID to browse available murals.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example           | Description                                              |
| ------------- | ------- | :------: | ----------------- | -------------------------------------------------------- |
| `next`        | string  |          | `"abc123token"`   | Pagination token for retrieving the next page of results |
| `limit`       | integer |          | `50`              | Maximum number of murals to return per page (must be ≥1) |
| `sortBy`      | string  |          | `"lastCreated"`   | Sort order for murals.                                   |
| `status`      | string  |          | `"active"`        | Status filter for murals.                                |
| `workspaceId` | string  |     ✅    | `"workspace1234"` | Unique identifier of the workspace to list murals from   |

### `Mural List Workspace Templates`

Integration name: **MURAL\_LIST\_WORKSPACE\_TEMPLATES**

Tool to get default and custom templates for a workspace. Use when you need to list available templates after authentication.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter        | Type    | Required | Example           | Description                                                                |
| ---------------- | ------- | :------: | ----------------- | -------------------------------------------------------------------------- |
| `next`           | string  |          | `"token123"`      | Pagination token for retrieving the next page of results                   |
| `limit`          | integer |          | `50`              | Maximum number of templates to return per page (must be ≥1)                |
| `workspaceId`    | string  |     ✅    | `"workspace1234"` | Unique identifier of the workspace to list templates from                  |
| `withoutDefault` | boolean |          | `true`            | If true, the list of returned templates will not include default templates |

### `Mural Search Murals`

Integration name: **MURAL\_SEARCH\_MURALS**

Tool to search for murals within a workspace. Returns all murals that the authenticated user owns or is a member of for the specified workspace. Use when searching for specific murals by query text.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example           | Description                                                                                       |
| ------------- | ------- | :------: | ----------------- | ------------------------------------------------------------------------------------------------- |
| `q`           | string  |     ✅    | `"Item"`          | The text this search query is for                                                                 |
| `next`        | string  |          | `"abc123token"`   | Token to get the next page of items                                                               |
| `limit`       | integer |          | `50`              | Maximum number of results to be returned by the endpoint (must be ≥1)                             |
| `roomId`      | integer |          | `1610033618903`   | Unique identifier of a room. When provided, restrict the results to murals in the specified room. |
| `workspaceId` | string  |     ✅    | `"workspace1234"` | Unique identifier of the workspace to search murals in                                            |

### `Mural Search Rooms`

Integration name: **MURAL\_SEARCH\_ROOMS**

Tool to search for rooms within a workspace by name or description. Returns all rooms that the authenticated user owns or is a member of matching the query. Use when you need to find specific rooms by search text.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example          | Description                                                  |
| ------------- | ------- | :------: | ---------------- | ------------------------------------------------------------ |
| `q`           | string  |     ✅    | `"room"`         | The search query text to filter rooms by name or description |
| `next`        | string  |          | `"abc123token"`  | Pagination token for retrieving the next page of results     |
| `limit`       | integer |          | `50`             | Maximum number of rooms to return per page (must be ≥1)      |
| `workspaceId` | string  |     ✅    | `"workspace123"` | Unique identifier of the workspace to search rooms from      |

### `Mural Search Templates`

Integration name: **MURAL\_SEARCH\_TEMPLATES**

Tool to search templates within a workspace that the authenticated user owns or has access to. Use when you need to find specific templates by name or keyword.

#### Parameters

Your Toolhouse AI worker will automatically pass these parameters as input when the tool is called.

| Parameter     | Type    | Required | Example          | Description                                                 |
| ------------- | ------- | :------: | ---------------- | ----------------------------------------------------------- |
| `q`           | string  |     ✅    | `"template"`     | The text search query for finding templates                 |
| `next`        | string  |          | `"abc123token"`  | Pagination token for retrieving the next page of results    |
| `limit`       | integer |          | `50`             | Maximum number of templates to return per page (must be ≥1) |
| `workspaceId` | string  |     ✅    | `"workspace123"` | Unique identifier of the workspace to search templates in   |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.toolhouse.ai/toolhouse/integrations/mural.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.