Sign in
latestOpenAPI 3.1.02026-08-21724493743.3 KB

2a1adc380310

public

Get Echo configuration

Return the workspace Echo widget configuration without private credentials.

get/api/v1/public/echo/configuration

Response

Successful Response

idstring required
workspaceIdstring required
positionstring required
themestring required
agentNamestring required
welcomeMessagestring required
logoUrlstring nullable
primaryColorstring required
userBubbleColorstring required
userBubbleTextColorstring required
botBubbleColorstring required
botBubbleTextColorstring required
headerGradientFromstring required
headerGradientTostring required
launcherSizestring required
borderRadiusstring required
shadowSizestring required
inputPlaceholderstring required
suggestionsstring[]
hideSuggestionsOnInteractboolean
previewMessagesstring[]
autoShowPreviewDelayinteger
showBrandingboolean
privacyPolicyUrlstring required
enableLeadCaptureboolean
leadCaptureKeywordsstring[]
leadCaptureMinutesThresholdinteger
leadCaptureMessageThresholdinteger
targetAgentIdForLeadsstring nullable
enableBrochureboolean
brochureSuggestionTextstring required
allowedDomainsstring[]
enableVoiceCallboolean
selectedUseCaseIdstring nullable
createdAtstring date-time required
updatedAtstring date-time required