Get Embed Config

GET /api/v1/public/embed/config/{token} — request parameters and responses from the Menace Voice API schema.

2 min read

get/api/v1/public/embed/config/{token}

Request example

curl --request GET \
  --url https://voice.menaceui.com/api/v1/public/embed/config/{token}

Response

{
  "workflow_id": 1,
  "settings": {},
  "texts": {
    "endChatText": "End chat",
    "conversationEndedText": "Conversation ended.",
    "startNewChatText": "Start new chat",
    "chatRetryText": "Retry",
    "chatInputPlaceholder": "Type a message…",
    "sendMessageLabel": "Send message",
    "closeChatLabel": "Close chat",
    "voiceConnectingText": "Connecting…",
    "voiceEndCallText": "End Call",
    "voiceRetryText": "Retry",
    "voiceReadyTitle": "Ready to Connect",
    "voiceConnectingSubtext": "Please wait while we establish the connection",
    "voiceConnectedTitle": "Connected",
    "voiceConnectedSubtext": "Your voice call is now active",
    "voiceCallEndedTitle": "Call ended",
    "voiceCallEndedSubtext": "Click below to start a new call",
    "voiceConnectionFailedTitle": "Connection failed",
    "voiceConnectionFailedSubtext": "Please check your microphone and try again",
    "voiceConnectionLostTitle": "Connection lost",
    "voiceConnectionLostSubtext": "The call has been disconnected"
  },
  "theme": "<string>",
  "position": "<string>",
  "button_text": "<string>",
  "button_color": "<string>",
  "size": "<string>",
  "auto_start": true,
  "turn_enabled": true,
  "force_turn_relay": true
}

get/api/v1/public/embed/config/{token}

See authentication for workspace API access. Public embed and artifact endpoints use their documented session or access tokens.

Path parameters

tokenstringrequired#

Responses

application/json

Successful Response

workflow_idintegerrequired#

settingsobjectrequired#

textsobjectrequired#

Every visitor-facing string the embed widget can render.

Show child attributes

endChatTextstring#

Default: "End chat"

conversationEndedTextstring#

Default: "Conversation ended."

startNewChatTextstring#

Default: "Start new chat"

chatRetryTextstring#

Default: "Retry"

chatInputPlaceholderstring#

Default: "Type a message…"

sendMessageLabelstring#

Default: "Send message"

closeChatLabelstring#

Default: "Close chat"

voiceConnectingTextstring#

Default: "Connecting…"

voiceEndCallTextstring#

Default: "End Call"

voiceRetryTextstring#

Default: "Retry"

voiceReadyTitlestring#

Default: "Ready to Connect"

voiceConnectingSubtextstring#

Default: "Please wait while we establish the connection"

voiceConnectedTitlestring#

Default: "Connected"

voiceConnectedSubtextstring#

Default: "Your voice call is now active"

voiceCallEndedTitlestring#

Default: "Call ended"

voiceCallEndedSubtextstring#

Default: "Click below to start a new call"

voiceConnectionFailedTitlestring#

Default: "Connection failed"

voiceConnectionFailedSubtextstring#

Default: "Please check your microphone and try again"

voiceConnectionLostTitlestring#

Default: "Connection lost"

voiceConnectionLostSubtextstring#

Default: "The call has been disconnected"

themestringrequired#

positionstringrequired#

button_textstringrequired#

button_colorstringrequired#

sizestringrequired#

auto_startbooleanrequired#

turn_enabledbooleanrequired#

force_turn_relaybooleanrequired#

Options Embed Config Get Public Turn Credentials