Voice Agent Sharing

Update Widget Config

Update Widget Config

Requires the OWNER or ADMIN role. Partial update of the embeddable widget's appearance and copy -- send at least one of the 24 keys listed here. Rejects any key outside this list (.unknown(false) in the server's validation) rather than silently ignoring it, unlike most other partial-update endpoints in this API.

patch/voice/sharing/{agentId}/widget-config

Request

  • Base URL: https://api.speakai.co/v1
  • URL: https://api.speakai.co/v1/voice/sharing/{agentId}/widget-config
  • Auth: API key in header x-speakai-key and API key in header x-access-token

Path parameters

agentIdstring required

Request body

displayMode'floating' | 'inline'
position'bottom-left' | 'bottom-right'
bubbleIconType'avatar' | 'generic'
buttonSize'small' | 'medium' | 'large'
buttonColorstring
theme'light' | 'dark' | 'auto'
compactModeboolean
defaultMode'voice' | 'avatar'
showAvatarboolean
fontFamilystring
borderRadiusnumber
backgroundColorstring
voiceEnabledboolean
enableUserCameraboolean
chatOpenByDefaultboolean
launcherTitlestring
launcherSubtitlestring
showLauncherboolean
beforeCallTitlestring
beforeCallDescriptionstring
startButtonLabelstring
afterCallTitlestring
afterCallDescriptionstring
feedbackEnabledboolean
companyLogoUrlstring

Response

OK

status'success'

Changes

No recorded changes to this operation across all 2 revisions of this API.