--- title: "Get Agent Widget Config" method: GET path: "/v1/convai/agents/{agent_id}/widget" tags: ["Agents Platform"] --- # Get Agent Widget Config `GET /v1/convai/agents/{agent_id}/widget` Retrieve the widget configuration for an agent ## Path parameters - `agent_id` string, required — The id of an agent. This is returned on agent creation. ## Query parameters - `conversation_signature` string, nullable — An expiring token that enables a websocket conversation to start. These can be generated for an agent using the /v1/convai/conversation/get_signed_url endpoint ## Headers - `xi-api-key` string, nullable — Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website. ## Response `200` Successful Response - GetAgentEmbedResponseModel - `agent_id` string, required - `widget_config` WidgetConfigResponseModel, required - `variant` 'tiny' | 'compact' | 'full' | 'expandable' - `placement` 'top-left' | 'top' | 'top-right' | 'bottom-left' | 'bottom' | 'bottom-right' - `expandable` 'never' | 'mobile' | 'desktop' | 'always' - `avatar` union — The avatar of the widget - OrbAvatar - `type` 'orb' — The type of the avatar - `color_1` string — The first color of the avatar - `color_2` string — The second color of the avatar - URLAvatar - `type` 'url' — The type of the avatar - `custom_url` string — The custom URL of the avatar - ImageAvatar - `type` 'image' — The type of the avatar - `url` string — The URL of the avatar - `feedback_mode` 'none' | 'during' | 'end' - `end_feedback` WidgetEndFeedbackConfig - `type` 'rating' - `bg_color` string — The background color of the widget - `text_color` string — The text color of the widget - `btn_color` string — The button color of the widget - `btn_text_color` string — The button text color of the widget - `border_color` string — The border color of the widget - `focus_color` string — The focus color of the widget - `border_radius` integer, nullable — The border radius of the widget - `btn_radius` integer, nullable — The button radius of the widget - `action_text` string, nullable — The action text of the widget - `start_call_text` string, nullable — The start call text of the widget - `end_call_text` string, nullable — The end call text of the widget - `expand_text` string, nullable — The expand text of the widget - `listening_text` string, nullable — The text to display when the agent is listening - `speaking_text` string, nullable — The text to display when the agent is speaking - `shareable_page_text` string, nullable — The text to display when sharing - `shareable_page_show_terms` boolean — Whether to show terms and conditions on the shareable page - `terms_text` string, nullable — The text to display for terms and conditions - `terms_html` string, nullable — The HTML to display for terms and conditions - `terms_key` string, nullable — The key to display for terms and conditions - `show_avatar_when_collapsed` boolean, nullable — Whether to show the avatar when the widget is collapsed - `disable_banner` boolean — Whether to disable the banner - `override_link` string, nullable — The override link for the widget - `markdown_link_allowed_hosts` AllowlistItem[] — List of allowed hostnames for clickable markdown links. Use { hostname: '*' } to allow any domain. Empty means no links are allowed. - `hostname` string, required — The hostname of the allowed origin - `markdown_link_include_www` boolean — Whether to automatically include www. variants of allowed hosts - `markdown_link_allow_http` boolean — Whether to allow http:// in addition to https:// for allowed hosts - `mic_muting_enabled` boolean — Whether to enable mic muting - `transcript_enabled` boolean — Whether the widget should show the conversation transcript as it goes on - `text_input_enabled` boolean — Whether the user should be able to send text messages - `conversation_mode_toggle_enabled` boolean — Whether to enable the conversation mode toggle in the widget - `default_expanded` boolean — Whether the widget should be expanded by default - `always_expanded` boolean — Whether the widget should always be expanded - `dismissible` boolean — Whether the widget can be dismissed by the user - `show_agent_status` boolean — Whether to show agent working/done/error status during tool use - `show_conversation_id` boolean — Whether to show the conversation ID after disconnection. - `strip_audio_tags` boolean — Whether to strip audio markup from messages. - `syntax_highlight_theme` 'light' | 'dark', nullable — Theme for code block syntax highlighting. Defaults to auto-detection by the widget when not set. - `text_contents` WidgetTextContents - `main_label` string, nullable — Call to action displayed inside the compact and full variants. - `start_call` string, nullable — Text and ARIA label for the start call button. - `start_chat` string, nullable — Text and ARIA label for the start chat button (text only) - `new_call` string, nullable — Text and ARIA label for the new call button. Displayed when the caller already finished at least one call in order ot start the next one. - `end_call` string, nullable — Text and ARIA label for the end call button. - `mute_microphone` string, nullable — ARIA label for the mute microphone button. - `change_language` string, nullable — ARIA label for the change language dropdown. - `collapse` string, nullable — ARIA label for the collapse button. - `expand` string, nullable — ARIA label for the expand button. - `copied` string, nullable — Text displayed when the user copies a value using the copy button. - `accept_terms` string, nullable — Text and ARIA label for the accept terms button. - `dismiss_terms` string, nullable — Text and ARIA label for the cancel terms button. - `listening_status` string, nullable — Status displayed when the agent is listening. - `speaking_status` string, nullable — Status displayed when the agent is speaking. - `connecting_status` string, nullable — Status displayed when the agent is connecting. - `chatting_status` string, nullable — Status displayed when the agent is chatting (text only) - `input_label` string, nullable — ARIA label for the text message input. - `input_placeholder` string, nullable — Placeholder text for the text message input. - `input_placeholder_text_only` string, nullable — Placeholder text for the text message input (text only) - `input_placeholder_new_conversation` string, nullable — Placeholder text for the text message input when starting a new conversation (text only) - `user_ended_conversation` string, nullable — Information message displayed when the user ends the conversation. - `agent_ended_conversation` string, nullable — Information message displayed when the agent ends the conversation. - `conversation_id` string, nullable — Text label used next to the conversation ID. - `error_occurred` string, nullable — Text label used when an error occurs. - `copy_id` string, nullable — Text and ARIA label used for the copy ID button. - `initiate_feedback` string, nullable — Text displayed to prompt the user for feedback. - `request_follow_up_feedback` string, nullable — Text displayed to request additional feedback details. - `thanks_for_feedback` string, nullable — Text displayed to thank the user for providing feedback. - `thanks_for_feedback_details` string, nullable — Additional text displayed explaining the value of user feedback. - `follow_up_feedback_placeholder` string, nullable — Placeholder text for the follow-up feedback input field. - `submit` string, nullable — Text and ARIA label for the submit button. - `go_back` string, nullable — Text and ARIA label for the go back button. - `send_message` string, nullable — Text and ARIA label for the send message button. - `text_mode` string, nullable — Text and ARIA label for the switch to text mode button. - `voice_mode` string, nullable — Text and ARIA label for the switch to voice mode button. - `switched_to_text_mode` string, nullable — Toast notification displayed when switching to text mode. - `switched_to_voice_mode` string, nullable — Toast notification displayed when switching to voice mode. - `copy` string, nullable — Text and ARIA label for the copy button. - `download` string, nullable — Text and ARIA label for the download button. - `wrap` string, nullable — Text and ARIA label for the wrap toggle button. - `agent_working` string, nullable — Status text displayed when the agent is processing a tool call. - `agent_done` string, nullable — Status text displayed when the agent finishes processing a tool call. - `agent_error` string, nullable — Status text displayed when the agent encounters an error during a tool call. - `attach_file` string, nullable — Text and ARIA label for the attach file button. - `remove_file` string, nullable — ARIA label for the remove file button. - `file_upload_error` string, nullable — Error message displayed when a file fails to upload. - `file_type_unsupported` string, nullable — Error message displayed when an unsupported file type is selected. Followed by the list of accepted types. - `file_too_large` string, nullable — Error message displayed when a file exceeds the maximum size limit. - `file_limit_reached` string, nullable — Error message displayed when the maximum number of files for a conversation is reached. - `typing_indicator` string, nullable — Status text displayed while the agent is typing. - `styles` WidgetStyles - `base` string, nullable — The base background color. - `base_hover` string, nullable — The color of the base background when hovered. - `base_active` string, nullable — The color of the base background when active (clicked). - `base_border` string, nullable — The color of the border against the base background. - `base_subtle` string, nullable — The color of subtle text against the base background. - `base_primary` string, nullable — The color of primary text against the base background. - `base_error` string, nullable — The color of error text against the base background. - `accent` string, nullable — The accent background color. - `accent_hover` string, nullable — The color of the accent background when hovered. - `accent_active` string, nullable — The color of the accent background when active (clicked). - `accent_border` string, nullable — The color of the border against the accent background. - `accent_subtle` string, nullable — The color of subtle text against the accent background. - `accent_primary` string, nullable — The color of primary text against the accent background. - `overlay_padding` number, nullable — The padding around the edges of the viewport. - `button_radius` number, nullable — The radius of the buttons. - `input_radius` number, nullable — The radius of the input fields. - `bubble_radius` number, nullable — The radius of the chat bubbles. - `sheet_radius` number, nullable — The default radius of sheets. - `compact_sheet_radius` number, nullable — The radius of the sheet in compact mode. - `dropdown_sheet_radius` number, nullable — The radius of the dropdown sheet. - `show_resize_button` boolean — Whether to show the resize button - `language` string, required - `supported_language_overrides` string[], nullable - `language_presets` object — Language presets for the widget - `text_only` boolean — Whether the agent uses text-only mode - `supports_text_only` boolean — Whether the agent can be switched to text-only mode - `first_message` string, nullable - `use_rtc` boolean, nullable — Whether to use WebRTC for conversation connections - `file_input_config` FileInputConfig - `enabled` boolean — When enabled, users may attach images or PDFs in chat when the LLM supports multimodal input. - `max_files_in_memory` integer — Number of most-recent files kept in memory during a conversation. Older files are summarized and their bytes freed. - `max_files_per_conversation` integer — Total files a user can upload in one conversation. Uploads are billed per file. Use -1 for no limit, or a value >= max_files_in_memory. ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation.md) · [All operations](https://skmtc.net/elevenlabs/apis/elevenlabs-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/elevenlabs/elevenlabs-api-documentation/revisions/e77a0a530a82/schema)