The Mural connector lets your AI agent act in each user's Mural account. Each user signs in to Mural once, and Scalekit stores and refreshes their tokens, so your agent never handles credentials. It comes with 61 tools.
- Tools
- 61
- What they doRead · write · destructive
- 25 · 30 · 625 read30 write6 destructive
- Users sign in with
- OAuth
- OAuth app
- Your own Mural app
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Mural connection
In AgentKit > Connections, create a Mural connection and copy its redirect URI. The name you give it is the
connection_nameyour code passes. See Configure connections.Register an OAuth app
Mural connections use your own OAuth app. Register one with Mural and add the redirect URI you copied.
Then enter the app's Client ID and Client Secret on the Mural connection.
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'mural'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize Mural:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'mural_get_current_user',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "mural"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize Mural:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="mural_get_current_user",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user signs in once. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolmural_get_current_userGet the profile of the authenticated Mural user.Read-onlyGet Current User
Get the profile of the authenticated Mural user. Returns a value object with the user's id, name, avatar, and company information. Use to confirm which account is connected. Requires the identity:read scope.
Inputs
This tool takes no inputs.
mural_get_muralGet one mural the authenticated user can read.Read-onlyGet Mural
Get one mural the authenticated user can read. Returns a value object with the mural's id, title, dimensions, timestamps, sharing and visitor settings. Use after a list or search tool to read full mural details.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
mural_get_mural_chatGet the chat messages of a mural.Read-onlyGet Mural Chat
Get the chat messages of a mural. Returns a value array of chat messages and a next token. Use to read discussion that happened in a mural.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_get_mural_exportGet the download URL of a mural export started with mural_export_mural.Read-onlyGet Mural Export
Get the download URL of a mural export started with mural_export_mural. Returns a value object with exportId, muralId, url, createdOn, and expireOn. Use after mural_export_mural. The URL expires at expireOn.
Inputs
export_idstringrequired- Identifier returned by mural_export_mural.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
mural_get_roomGet one room the authenticated user can read.Read-onlyGet Room
Get one room the authenticated user can read. Returns a value object with the room's id, name, description, type, confidential flag, workspaceId, and timestamps. Use after a list or search tool to read full room details.
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
mural_get_tagGet one tag on a mural.Read-onlyGet Tag
Get one tag on a mural. Returns a value object with the tag's id, text, and colors. Use mural_list_tags to see all tags.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
tag_idstringrequired- Unique identifier of the tag. Get it from mural_list_tags.
mural_get_widgetGet one widget on a mural by ID.Read-onlyGet Widget
Get one widget on a mural by ID. Returns a value object with the widget's type, position, size, text, and style. Use mural_list_widgets to discover widget IDs.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
mural_get_workspaceGet one workspace the authenticated user can read.Read-onlyGet Workspace
Get one workspace the authenticated user can read. Returns a value object with the workspace's id, name, and settings. Use mural_list_workspaces to browse workspaces instead.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
mural_list_default_templatesList Mural's default templates.Read-onlyList Default Templates
List Mural's default templates. Returns a value array of templates (id, name, description, category) and a next token. Use mural_list_workspace_templates to include a workspace's custom templates.
Inputs
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_mural_usersList the members and guests of a mural.Read-onlyList Mural Users
List the members and guests of a mural. Returns a value array of users and a next token. Use to see who has access. Use mural_list_room_users for a room.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_open_roomsList the discoverable open rooms in a workspace.Read-onlyList Open Rooms
List the discoverable open rooms in a workspace. Returns a value array of rooms and a next token. Use to find rooms the user could join. Use mural_list_workspace_rooms for rooms the user already accesses.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_recent_muralsList the active murals the authenticated user opened most recently in a workspace.Read-onlyList Recent Murals
List the active murals the authenticated user opened most recently in a workspace. Returns a value array of mural summaries and a next token. Use for a quick shortlist. Use mural_list_workspace_murals for the full set.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_recent_templatesList the templates the authenticated user used recently in a workspace.Read-onlyList Recent Templates
List the templates the authenticated user used recently in a workspace. Returns a value array of templates and a next token. Use for a shortlist. Use mural_list_workspace_templates for all templates.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
without_defaultboolean- Set true to leave out Mural's default templates and return only custom ones.
mural_list_room_foldersList the folders in a room.Read-onlyList Room Folders
List the folders in a room. Returns a value array of folders with id, name, and nested children, plus a next token. Use to find a folder_id for creating or moving murals.
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_room_muralsList the murals in a room that the authenticated user can read, optionally within one folder.Read-onlyList Room Murals
List the murals in a room that the authenticated user can read, optionally within one folder. Returns a value array of mural summaries and a next token. Use to browse a single room. Use mural_list_workspace_murals across the workspace.
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
folder_idstring- Only return murals in this folder. Get folder IDs from mural_list_room_folders.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
sort_bystring- Sort order: lastCreated (newest first), lastModified (most recently changed first), or oldest.one of
lastCreatedlastModifiedoldest statusstring- Filter murals by status: active or archived.one of
activearchived
mural_list_room_usersList the members and guests of a room.Read-onlyList Room Users
List the members and guests of a room. Returns a value array of users and a next token. Use to see who has access to a room. Use mural_list_mural_users for a single mural.
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_widgetsList widgets on a mural, optionally filtered by type or parent.Read-onlyList Widgets
List widgets on a mural, optionally filtered by type or parent. Drawings are not included. Returns a value array of widgets (id, type, position, size, text, style) and a next token. Use to find widget_ids before reading, updating, or deleting. Use mural_get_widget for one widget.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
parent_idstring- Only return widgets inside this parent widget, such as an area.
typestring- Comma-separated widget types to return: areas, arrows, comments, files, sticky notes, texts, icons, images, shapes. Omit for all types.
mural_list_workspace_muralsList murals the authenticated user owns or is a member of in a workspace.Read-onlyList Workspace Murals
List murals the authenticated user owns or is a member of in a workspace. Returns a value array of mural summaries (id, title, thumbnail, timestamps) and a next token. Use to browse all murals. Use mural_list_recent_murals for recently opened ones, mural_search_murals for a text query, mural_list_room_murals to scope to a room.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
sort_bystring- Sort order: lastCreated (newest first), lastModified (most recently changed first), or oldest.one of
lastCreatedlastModifiedoldest statusstring- Filter murals by status: active or archived.one of
activearchived
mural_list_workspace_roomsList rooms in a workspace that the authenticated user can read.Read-onlyList Workspace Rooms
List rooms in a workspace that the authenticated user can read. Returns a value array of rooms (id, name, type, workspaceId) and a next token. Use to find a room_id. Use mural_list_open_rooms for discoverable open rooms, mural_search_rooms for a text query.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_list_workspace_templatesList default and custom templates available in a workspace.Read-onlyList Workspace Templates
List default and custom templates available in a workspace. Returns a value array of templates and a next token. Use to find a template_id. Use mural_list_recent_templates for recently used ones, mural_search_templates for a text query.
Inputs
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
without_defaultboolean- Set true to leave out Mural's default templates and return only custom ones.
mural_list_workspacesList the Mural workspaces the authenticated user belongs to, active or inactive.Read-onlyList Workspaces
List the Mural workspaces the authenticated user belongs to, active or inactive. Returns a value array of workspaces (id, name, and related properties) and a next token for further pages. Use to find a workspace_id. Use mural_get_workspace for one workspace.
Inputs
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_search_muralsSearch murals in a workspace by text, optionally within one room.Read-onlySearch Murals
Search murals in a workspace by text, optionally within one room. Returns a value array of matching mural summaries and a next token. Use when you have keywords. Use mural_list_workspace_murals to browse.
Inputs
qstringrequired- Text to search for. Must not be empty.
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
room_idinteger- Restrict results to murals in this room.
mural_search_roomsSearch rooms in a workspace by text.Read-onlySearch Rooms
Search rooms in a workspace by text. Returns a value array of matching rooms and a next token. Use when you have keywords. Use mural_list_workspace_rooms to browse.
Inputs
qstringrequired- Text to search for. Must not be empty.
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_search_templatesSearch the custom templates a user owns or can access in a workspace.Read-onlySearch Templates
Search the custom templates a user owns or can access in a workspace. Returns a value array of matching templates and a next token. Use when you have keywords. Use mural_list_workspace_templates to browse.
Inputs
qstringrequired- Text to search for. Must not be empty.
workspace_idstringrequired- Identifier of the workspace. Get it from the list workspaces tool.
limitinteger- Maximum number of results to return in one page. Omit to use the server default.
nextstring- Pagination token from the 'next' field of a previous response. Omit to start at the first page.
mural_create_areaCreate an area (container) widget on a mural.WriteCreate Area
Create an area (container) widget on a mural. Returns a value object with the created area (id, position, size, title). Use to group widgets. Pass the area's id as parent_id when creating widgets inside it.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
background_colorstring- Fill color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_stylestring- Border style: solid, dashed, dotted-spaced, or dotted.one of
soliddasheddotted-spaceddotted border_widthnumber- Border width in px, from 1 to 7.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
layoutstring- How widgets inside the area are arranged: free, column, or row.one of
freecolumnrow parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
show_titleboolean- Set true to show the area title.
titlestring- Title of the area.
title_font_sizenumber- Font size of the area title.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_create_arrowCreate an arrow widget on a mural, optionally connecting two widgets.WriteCreate Arrow
Create an arrow widget on a mural, optionally connecting two widgets. Returns a value object with the created arrow (id, points, position). Use to link shapes or notes. Set start_ref_id and end_ref_id to attach it to widgets.
Inputs
heightnumberrequired- Height of the widget in px.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
pointsarrayrequired- Two or more points, each with x and y in px, that the arrow passes through.
widthnumberrequired- Width of the widget in px.
xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
arrow_typestring- Line shape: straight, curved, or orthogonal.one of
straightcurvedorthogonal end_ref_idstring- ID of the widget the arrow ends at.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
start_ref_idstring- ID of the widget the arrow starts from.
stroke_colorstring- Line color. Hex color with alpha channel, 8 uppercase hex digits after the #.
stroke_stylestring- Line style: solid, dashed, dotted-spaced, or dotted.one of
soliddasheddotted-spaceddotted stroke_widthnumber- Line width in px, from 1 to 7.
tipstring- Arrow tip: no tip, single, or double.one of
no tipsingledouble titlestring- Title of the widget, shown as its label in the mural.
mural_create_commentCreate a comment widget on a mural, optionally attached to another widget.WriteCreate Comment
Create a comment widget on a mural, optionally attached to another widget. Returns a value object with the created comment (id, message, position). Use to leave feedback on a mural. Use mural_update_comment to resolve or edit it.
Inputs
messagestringrequired- Text of the comment.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
reference_widget_idstring- ID of the widget this comment is attached to.
resolvedboolean- Set true to create the comment already resolved.
mural_create_muralCreate a blank mural in a room the authenticated user can write to.WriteCreate Mural
Create a blank mural in a room the authenticated user can write to. Returns a value object with the new mural's id, title, and settings. Use mural_create_mural_from_template to start from a template. Needs a room_id from the list rooms tools.
Inputs
room_idintegerrequired- Numeric ID of the room that will contain the mural.
background_colorstring- Background color of the mural. Hex color with alpha channel, 8 uppercase hex digits after the #.
folder_idstring- ID of a folder inside the room to place the mural in.
heightnumber- Height of the mural canvas in px.
infiniteboolean- Set true for a borderless canvas that grows as widgets are added.
titlestring- Title of the new mural.
widthnumber- Width of the mural canvas in px.
mural_create_mural_from_templateCreate a mural in a room from a default or custom template.WriteCreate Mural From Template
Create a mural in a room from a default or custom template. Returns a value object with the new mural's id, title, and settings. Use to start from a template. Get template_id from mural_list_workspace_templates.
Inputs
room_idintegerrequired- Numeric ID of the room that will contain the mural.
template_idstringrequired- Unique identifier of the template. Get it from the template list tools.
titlestringrequired- Title of the new mural.
folder_idstring- ID of a folder in the room to place the mural in.
mural_create_roomCreate an open or private room in a workspace.WriteCreate Room
Create an open or private room in a workspace. Returns a value object with the new room's id, name, type, and workspaceId. Use to set up a space for murals. Needs a workspace_id from mural_list_workspaces.
Inputs
namestringrequired- Name of the room.
typestringrequired- Room visibility: open (discoverable) or private.one of
openprivate workspace_idstringrequired- ID of the workspace that will contain the room.
confidentialboolean- Set true to mark the room confidential.
descriptionstring- Description of the room.
mural_create_room_folderCreate a folder in a room, optionally inside another folder.WriteCreate Room Folder
Create a folder in a room, optionally inside another folder. Returns a value object with the folder's id, name, and children. Use to organize murals. Needs a room_id.
Inputs
namestringrequired- Name of the folder.
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
parent_idstring- ID of an existing folder to nest this one under.
mural_create_shapeCreate a shape widget on a mural.WriteCreate Shape
Create a shape widget on a mural. Returns a value array containing the created widget (id, type, position, size, text). Use for diagrams and flowcharts. Use mural_create_arrow to connect shapes.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
shapestringrequired- Shape type, such as rectangle, circle, diamond, or decision.one of
circlediamondhexagonpentagonsquaretrianglearrow_downarrow_left_rightarrow_leftarrow_rightarrow_topbadgebrace_leftbrace_rightchonk_unicorncloudconnectorcrossdatadatabasedecisiondelaydirect_datadisplaydocumentellipseendhexagon_smartinternal_storagemanual_inputmanual_loopmergemultiple_documentsnote_leftnote_rightoctagonoff_page_connectororpapertapepentagon_smartporongopredefined_processpreparationprocessrectanglerhombus_smartribbonright_trianglerounded_squaresimple_ribbonspeech_bubble_centerspeech_bubble_leftspeech_bubble_rightstarstartstepstored_datasumming_junctionteardrop_bubbleterminatorthinking_bubble_leftthinking_bubble_righttrapezoidtriangle_smart xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
background_colorstring- Fill color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_stylestring- Border style: solid or dotted.one of
soliddotted border_widthnumber- Border width in px.
font_colorstring- Text color. Hex color with alpha channel, 8 uppercase hex digits after the #.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
html_textstring- Text with inline HTML formatting. Takes priority over text when both are set.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Plain text shown inside the shape.
titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
mural_create_sticky_noteCreate a sticky note on a mural.WriteCreate Sticky Note
Create a sticky note on a mural. Returns a value array containing the created widget (id, type, position, size, text). Use for short ideas or comments. Use mural_create_textbox for free text. Use mural_update_sticky_note to edit one.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
shapestringrequired- Shape of the sticky note: circle or rectangle.one of
circlerectangle xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
background_colorstring- Background color of the note. Hex color with alpha channel, 8 uppercase hex digits after the #.
boldboolean- Set true for bold text.
font_sizenumber- Font size of the text.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
html_textstring- Text with inline HTML formatting (b, i, u, s, ul, ol, li). Takes priority over text when both are set.
hyperlinkstring- URL the note links to.
instructionstring- Facilitator instruction attached to the widget.
italicboolean- Set true for italic text.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
tagsarray- IDs of existing tags to attach. Get tag IDs from mural_list_tags.
textstring- Plain text shown on the sticky note.
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
mural_create_tableCreate a table widget on a mural from column, row, and cell definitions.WriteCreate Table
Create a table widget on a mural from column, row, and cell definitions. Returns a value array containing the created table widgets. Use for structured grids. Define columns, rows, and cells together; cells reference column and row IDs.
Inputs
cellsarrayrequired- Cell definitions, one per grid position, each referencing a columnId and rowId and holding the cell text. Example: [{"columnId": "c1", "rowId": "r1", "text": "Name"}].
columnsarrayrequired- Column definitions. Each column needs a columnId you choose and a width in px.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
rowsarrayrequired- Row definitions. Each row needs a rowId you choose and a height in px.
xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
auto_resizeboolean- Set true to let rows grow to fit their text.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
mural_create_tagCreate a tag on a mural.WriteCreate Tag
Create a tag on a mural. Returns a value object with the new tag's id, text, and colors. Use before tagging sticky notes. Tag text is limited to 25 characters.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
textstringrequired- Tag text, up to 25 characters.
background_colorstring- Tag background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Tag border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
colorstring- Tag text color. Hex color with alpha channel, 8 uppercase hex digits after the #.
mural_create_templateCreate a custom template from an existing mural.WriteCreate Template
Create a custom template from an existing mural. Returns a value object with the new template's id, name, and description. Use to reuse a mural's layout. Use mural_create_mural_from_template to apply a template.
Inputs
mural_idstringrequired- ID of the mural to turn into a template.
titlestringrequired- Title of the template.
descriptionstring- Description of the template.
mural_create_textboxCreate a text box on a mural.WriteCreate Textbox
Create a text box on a mural. Returns a value array containing the created widget (id, type, position, size, text). Use for free-form text. Use mural_create_title for headings and mural_create_sticky_note for ideas.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
background_colorstring- Background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
fontstring- Font family.one of
adelleblambot-casualblambot-prolint-mccreemarker-feltmuseo-slabproxima-novashark-water font_sizenumber- Font size of the text.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Text of the text box. Supports inline HTML formatting (b, i, u, s).
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
mural_create_titleCreate a title (heading) widget on a mural.WriteCreate Title
Create a title (heading) widget on a mural. Returns a value array containing the created widget (id, type, position, size, text). Use for large headings. Use mural_create_textbox for body text.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
xnumberrequired- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumberrequired- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
background_colorstring- Background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
fontstring- Font family.one of
adelleblambot-casualblambot-prolint-mccreemarker-feltmuseo-slabproxima-novashark-water font_sizenumber- Font size of the title.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Text of the title. Supports inline HTML formatting (b, i, u, s).
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
mural_duplicate_muralDuplicate a mural into a room under a new title.WriteDuplicate Mural
Duplicate a mural into a room under a new title. Returns a value object with the new mural's id, title, and settings. Use to copy an existing mural. Use mural_create_mural_from_template to copy a template.
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
room_idintegerrequired- Numeric ID of the room that will contain the copy.
titlestringrequired- Title of the duplicated mural.
folder_idstring- ID of a folder in the room to place the copy in.
infiniteboolean- Set true for a borderless canvas on the copy.
mural_export_muralStart an export of a mural to a file, such as a PDF.WriteExport Mural
Start an export of a mural to a file, such as a PDF. Returns a value object with an exportId. Use the exportId with mural_get_mural_export to get the download URL once the export is ready.
Inputs
download_formatstringrequired- File extension to export to.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
mural_invite_mural_usersInvite members or guests to a mural by email address or username.WriteInvite Mural Users
Invite members or guests to a mural by email address or username. Returns a value array with one result per invitation (email, username, refCode, rejected, reason). Inviting by email sends an invitation email. Inviting by username adds the user immediately. Use mural_invite_room_users for a room.
Inputs
invitationsarrayrequired- People to invite. Each entry has an email or a username, and an optional editPermission of view or edit. Example: [{"email": "sam@example.com", "editPermission": "edit"}].
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
messagestring- Personal message included in the invitation.
send_emailboolean- Set false to skip the invitation email.
mural_invite_room_usersInvite members or guests to a room by email address or username.WriteInvite Room Users
Invite members or guests to a room by email address or username. Returns a value array with one result per invitation (email, username, refCode, rejected, reason). Inviting by email sends an invitation email. Inviting by username adds the user immediately. Use mural_invite_mural_users for a single mural.
Inputs
invitationsarrayrequired- People to invite. Each entry has an email or a username. Example: [{"email": "sam@example.com"}].
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
messagestring- Personal message included in the invitation.
send_emailboolean- Set false to skip the invitation email.
mural_remove_mural_usersRemove members or guests from a mural by email address.WriteRemove Mural Users
Remove members or guests from a mural by email address. Returns a value array of the removal results. Use to revoke access to one mural. Use mural_remove_room_users for a room.
Inputs
emailsarrayrequired- Email addresses of the users to remove.
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
mural_remove_room_usersRemove members or guests from a room by email address.WriteRemove Room Users
Remove members or guests from a room by email address. Returns a value array of the removal results. Use to revoke access to a room. Use mural_remove_mural_users for a single mural.
Inputs
emailsarrayrequired- Email addresses of the users to remove.
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
mural_update_areaUpdate an area widget on a mural.WriteUpdate Area
Update an area widget on a mural. Returns a value object with the updated area. Use to rename, move, resize, or restyle an area. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
background_colorstring- Fill color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_stylestring- Border style: solid, dashed, dotted-spaced, or dotted.one of
soliddasheddotted-spaceddotted border_widthnumber- Border width in px, from 1 to 7.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
layoutstring- How widgets inside the area are arranged: free, column, or row.one of
freecolumnrow parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
show_titleboolean- Set true to show the area title.
titlestring- Title of the area.
title_font_sizenumber- Font size of the area title.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_arrowUpdate an arrow widget on a mural.WriteUpdate Arrow
Update an arrow widget on a mural. Returns a value object with the updated arrow. Use to reroute, restyle, or reattach an arrow. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
arrow_typestring- Line shape: straight, curved, or orthogonal.one of
straightcurvedorthogonal end_ref_idstring- ID of the widget the arrow ends at.
heightnumber- Height of the widget in px.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
pointsarray- Replacement list of two or more points, each with x and y in px.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
start_ref_idstring- ID of the widget the arrow starts from.
stroke_colorstring- Line color. Hex color with alpha channel, 8 uppercase hex digits after the #.
stroke_stylestring- Line style: solid, dashed, dotted-spaced, or dotted.one of
soliddasheddotted-spaceddotted stroke_widthnumber- Line width in px, from 1 to 7.
tipstring- Arrow tip: no tip, single, or double.one of
no tipsingledouble titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_commentUpdate a comment widget on a mural: edit it, move it, resolve it, or add replies.WriteUpdate Comment
Update a comment widget on a mural: edit it, move it, resolve it, or add replies. Returns a value object with the updated comment. Use to resolve a comment (resolved true) or add replies. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
messagestring- New text of the comment.
reference_widget_idstring- ID of the widget this comment is attached to.
repliesarray- Reply messages to add to the comment thread.
resolvedboolean- Set true to mark the comment resolved.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_muralUpdate a mural's title, size, background, status, folder, or access permissions.WriteUpdate Mural
Update a mural's title, size, background, status, folder, or access permissions. Returns a value object with the updated mural. Use to rename, archive (status archived), or change permissions. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
background_colorstring- Background color of the mural. Hex color with alpha channel, 8 uppercase hex digits after the #.
favoriteboolean- Set true to favorite the mural for the authenticated user.
folder_idstring- Move the mural to this folder ID.
heightinteger- Canvas height in px, between 3000 and 60000.
infiniteboolean- Set true for a borderless canvas that grows as widgets are added.
statusstring- Set to archived to archive the mural or active to restore it.one of
activearchived titlestring- New title for the mural.
visitors_permissionstring- Access level for visitors: read, write, or none.one of
readwritenone widthinteger- Canvas width in px, between 3000 and 60000.
workspace_members_permissionstring- Access level for workspace members: read, write, or none.one of
readwritenone
mural_update_roomUpdate a room's name, description, type, or favorite flag.WriteUpdate Room
Update a room's name, description, type, or favorite flag. Returns a value object with the updated room. Use to rename or change a room's visibility. Only send the fields to change.
- Idempotent
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
descriptionstring- New description for the room.
favoriteboolean- Set true to favorite the room for the authenticated user.
namestring- New name for the room.
typestring- Room visibility: open or private.one of
openprivate
mural_update_shapeUpdate a shape widget on a mural.WriteUpdate Shape
Update a shape widget on a mural. Returns a value object with the updated widget. Use to edit shape text, position, or style. The shape type itself cannot be changed. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
background_colorstring- Fill color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_stylestring- Border style: solid or dotted.one of
soliddotted border_widthnumber- Border width in px.
font_colorstring- Text color. Hex color with alpha channel, 8 uppercase hex digits after the #.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
html_textstring- Text with inline HTML formatting. Takes priority over text when both are set.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Plain text shown inside the shape.
titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_sticky_noteUpdate a sticky note on a mural.WriteUpdate Sticky Note
Update a sticky note on a mural. Returns a value object with the updated widget. Use to edit text, position, or style. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
background_colorstring- Background color of the note. Hex color with alpha channel, 8 uppercase hex digits after the #.
boldboolean- Set true for bold text.
font_sizenumber- Font size of the text.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
html_textstring- Text with inline HTML formatting (b, i, u, s). Takes priority over text when both are set.
hyperlinkstring- URL the note links to.
instructionstring- Facilitator instruction attached to the widget.
italicboolean- Set true for italic text.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
tagsarray- Full list of tag IDs for the note, replacing the current tags.
textstring- Plain text shown on the sticky note.
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_tagUpdate a tag's text or colors on a mural.WriteUpdate Tag
Update a tag's text or colors on a mural. Returns a value object with the updated tag. Use to rename or recolor a tag. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
tag_idstringrequired- Unique identifier of the tag. Get it from mural_list_tags.
background_colorstring- Tag background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
border_colorstring- Tag border color. Hex color with alpha channel, 8 uppercase hex digits after the #.
colorstring- Tag text color. Hex color with alpha channel, 8 uppercase hex digits after the #.
textstring- Tag text, up to 25 characters.
mural_update_textboxUpdate a text box on a mural.WriteUpdate Textbox
Update a text box on a mural. Returns a value object with the updated widget. Use to edit text, position, or style. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
background_colorstring- Background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
fontstring- Font family.one of
adelleblambot-casualblambot-prolint-mccreemarker-feltmuseo-slabproxima-novashark-water font_sizenumber- Font size of the text.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Text of the text box. Supports inline HTML formatting (b, i, u, s).
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_update_titleUpdate a title widget on a mural.WriteUpdate Title
Update a title widget on a mural. Returns a value object with the updated widget. Use to edit heading text, position, or style. Only send the fields to change.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
background_colorstring- Background color. Hex color with alpha channel, 8 uppercase hex digits after the #.
fontstring- Font family.one of
adelleblambot-casualblambot-prolint-mccreemarker-feltmuseo-slabproxima-novashark-water font_sizenumber- Font size of the title.
heightnumber- Height of the widget in px.
hiddenboolean- Set true to hide the widget from participants.
instructionstring- Facilitator instruction attached to the widget.
parent_idstring- ID of a parent widget, such as an area, to place this widget inside.
rotationnumber- Rotation angle in degrees, from 0 up to but not including 360.
textstring- Text of the title. Supports inline HTML formatting (b, i, u, s).
text_alignstring- Text alignment: left, center, or right.one of
leftcenterright titlestring- Title of the widget, shown as its label in the mural.
widthnumber- Width of the widget in px.
xnumber- Horizontal position in px, measured from the left of the parent widget (or the mural if there is no parent).
ynumber- Vertical position in px, measured from the top of the parent widget (or the mural if there is no parent).
mural_delete_muralDelete a mural the authenticated user owns.DestructiveDelete Mural
Delete a mural the authenticated user owns. Returns no body on success (HTTP 204). Use mural_update_mural with status archived for a reversible removal.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
mural_delete_roomDelete a room the authenticated user owns.DestructiveDelete Room
Delete a room the authenticated user owns. Returns no body on success (HTTP 204). Deletion is permanent. Confirm the room_id with mural_get_room first.
- Idempotent
Inputs
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
mural_delete_room_folderDelete a folder from a room together with its sub-folders and murals.DestructiveDelete Room Folder
Delete a folder from a room together with its sub-folders and murals. Returns no body on success (HTTP 204). Deletion is permanent and includes the murals inside. Check contents with mural_list_room_murals first.
- Idempotent
Inputs
folder_idstringrequired- Unique identifier of the folder. Get it from mural_list_room_folders.
room_idintegerrequired- Numeric identifier of the room. Get it from the list rooms tools.
mural_delete_tagDelete a tag from a mural.DestructiveDelete Tag
Delete a tag from a mural. Returns no body on success (HTTP 204). Use to remove an unused tag. Check mural_list_tags first.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
tag_idstringrequired- Unique identifier of the tag. Get it from mural_list_tags.
mural_delete_templateDelete a custom template the authenticated user owns.DestructiveDelete Template
Delete a custom template the authenticated user owns. Returns no body on success (HTTP 204). Deletion is permanent. Murals already created from the template are not affected.
- Idempotent
Inputs
template_idstringrequired- Unique identifier of the template. Get it from the template list tools.
mural_delete_widgetDelete a widget and its content from a mural.DestructiveDelete Widget
Delete a widget and its content from a mural. Returns no body on success (HTTP 204). Deletion is permanent. Confirm the widget with mural_get_widget first.
- Idempotent
Inputs
mural_idstringrequired- Unique identifier of the mural, in the form <workspaceId>.<timestamp>. Get it from mural list or search tools.
widget_idstringrequired- Unique identifier of the widget on the mural. Get it from the list widgets tool.
No tools match.
