Use the Speak AI MCP server tool update_embed to update an existing embed widget:
appearance/feature toggles via meta, and privacy.
What does it do?
Update an existing embed widget: appearance/feature toggles via meta, and privacy.
Passing mediaId with privacyMode sets that privacy mode on the media file
itself; a public mode makes the media viewable by anyone with the embed link.
Setting privacyMode clears any existing password unless a new one is supplied in
the same call.
Parameters
update_embed takes 5 parameters, 1 of them required.
| Name | Type | Required | Description |
|---|---|---|---|
embedId |
string | Yes | Unique identifier of the embed |
mediaId |
string | No | Media file whose privacy mode is set to privacyMode. Does not change which media the embed points to. |
privacyMode |
string | No | Privacy mode for the embed. Changing this clears the existing password unless password is also supplied in the same call. |
password |
string | No | Password to protect the embed with when privacyMode is private. Only applied when privacyMode is also sent. |
meta |
object | No | Embed appearance & feature toggles: { backgroundImg, logo, logoDark, theme, backgroundColor, fontFamily, primaryColor, titleColor, chatWelcomeMessage, assistantTemplateId, isTitle, isDescription, isRemarks, isDataVizDownloadable, isSEOIndexing, isPromptAsk, isPromptHistory, isMediaExport, isLabels, isComments, callToActionButtons:[{ url, label }], features:[{ name, isActive, isCustom? }] }. features entry { name: “fieldsFocus”, isActive: false } turns off the fields-first media page: by default, when a media page is opened from a shared dashboard and the media has custom fields, the page shrinks the player to about 22% and leads with the fields. Shared-dashboard branding: logo is the image shown in light mode and logoDark the one shown when the viewer is in dark mode (logoDark must be an uploaded logo; this MCP cannot upload images, any other URL is rejected with a 400, and it falls back to logo when unset). theme is “light” or “dark” and forces that theme for every viewer, hiding their toggle; “” lets the viewer choose. backgroundColor is a hex colour (#rgb or #rrggbb) for the page background; pair it with theme so text stays readable. primaryColor is a hex accent used for nav, links, card chips and play buttons. titleColor is a hex colour for the dashboard title and is ignored when its contrast on the page background is below 3:1. fontFamily is a Google Fonts family name (letters, digits and spaces, max 60 chars, for example “Arimo”; anything else is rejected with a 400); it overrides the account font for this embed, and “” falls back to the account font. Send “” for any of these keys to clear it. isPromptAsk must be on for the chat button of a shared dashboard (and a notes widget openChat action) to work. isLabels and isComments show the media’s labels and comments read-only on media and folder embeds; both are off by default and embed viewers can never write them. |
Behaviour
The Speak AI MCP server publishes these behaviour hints for update_embed.
- Can change data in your workspace.
- Can delete or overwrite data. Use with care.
- Repeating an identical call is safe.
- Can reach systems outside Speak AI.
Related
- Embed players lists the rest of the Embed players category.
- Tool reference lists every Speak AI MCP server tool.
- MCP server covers setup, supported clients, and what agents can do once connected.