Use the Speak AI MCP server tool update_embed to update an existing embed widget:
appearance/feature toggles via meta, plus scope and privacy.
What does it do?
Update an existing embed widget: appearance/feature toggles via meta, plus scope
and privacy. 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 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, primaryColor, titleColor, chatWelcomeMessage, assistantTemplateId, isTitle, isDescription, isRemarks, isDataVizDownloadable, isSEOIndexing, isPromptAsk, isPromptHistory, isMediaExport, callToActionButtons:[{ url, label }], features:[{ name, isActive, isCustom? }] } |
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.
- Stays inside Speak AI. Does not reach other systems.
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.