Skip to content

Update Embed Widget

Update an existing embed widget: appearance/feature toggles via `meta`, plus scope and privacy.

Updated View as MarkdownAsk ClaudeOpen in ChatGPTllms.txt

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.

Parameters

update_embed takes 6 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
folderIds array of string No Folder IDs the embed covers
privacyMode string No Privacy mode for the embed
embedType string No Embed type
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.
  • Does not delete or overwrite existing data.
  • Repeating an identical call is safe.
  • Can reach systems outside Speak AI.
  • 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.
Navigation

Type to search…

↑↓ navigate↵ selectEsc close