> This is a page from the ElevenLabs documentation. For a complete page index, fetch https://elevenlabs.io/docs/llms.txt. For the full documentation in a single file, fetch https://elevenlabs.io/docs/llms-full.txt. # Agent-Widget-Konfiguration abrufen GET https://api.elevenlabs.io/v1/convai/agents/{agent_id}/widget Widget-Konfiguration für einen Agenten abrufen Reference: https://elevenlabs.io/docs/api-reference/widget/get ## Servers - `https://api.elevenlabs.io` (Production, default) - `https://api.us.elevenlabs.io` (Production US) - `https://api.eu.residency.elevenlabs.io` (Production EU) - `https://api.in.residency.elevenlabs.io` (Production India) - `https://api.sg.residency.elevenlabs.io` (Production Singapore) ## Request ### Path parameters - `agent_id` (string, required) — Die ID eines Agenten. Sie wird beim Erstellen des Agenten zurückgegeben. ### Query parameters - `conversation_signature` (string, optional, nullable) — Ein ablaufender Token, der den Start einer WebSocket-Unterhaltung ermöglicht. Er kann für einen Agenten über den Endpunkt /v1/convai/conversation/get_signed_url generiert werden. ## Response ### 200 Erfolgreiche Antwort - `agent_id` (string, required) - `widget_config` (WidgetConfigResponseModel, required) ## Errors ### 422 Unprocessable Entity Error Validierungsfehler - `detail` (list of ValidationError, optional) ## Types ### WidgetConfigResponseModel - `language` (string, required) - `variant` (enum, optional, default: full) — Die Variante des Widgets - Allowed values: `tiny`, `compact`, `full`, `expandable` - `placement` (enum, optional, default: bottom-right) — Die Position des Widgets auf dem Bildschirm - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right` - `expandable` (enum, optional, default: never) — Ob das Widget erweiterbar ist. - Allowed values: `never`, `mobile`, `desktop`, `always` - `avatar` (WidgetConfigResponseModelAvatar, optional) — Der Avatar des Widgets - `feedback_mode` (enum, optional, default: none) — Der Feedback-Modus des Widgets - Allowed values: `none`, `during`, `end` - `end_feedback` (WidgetEndFeedbackConfig, optional, nullable) — Konfiguration für am Ende der Unterhaltung erfasstes Feedback - `bg_color` (string, optional, default: #ffffff) — Die Hintergrundfarbe des Widgets - `text_color` (string, optional, default: #000000) — Die Textfarbe des Widgets - `btn_color` (string, optional, default: #000000) — Die Schaltflächenfarbe des Widgets - `btn_text_color` (string, optional, default: #ffffff) — Die Textfarbe der Schaltfläche im Widget - `border_color` (string, optional, default: #e1e1e1) — Die Rahmenfarbe des Widgets - `focus_color` (string, optional, default: #000000) — Die Fokusfarbe des Widgets - `border_radius` (integer, optional, nullable) — Der Rahmenradius des Widgets - `btn_radius` (integer, optional, nullable) — Der Schaltflächenradius des Widgets - `action_text` (string, optional, nullable) — Der Aktionstext des Widgets - `start_call_text` (string, optional, nullable) — Der Text für den Gesprächsstart des Widgets - `end_call_text` (string, optional, nullable) — Der Text zum Beenden des Anrufs im Widget - `expand_text` (string, optional, nullable) — Der Erweiterungstext des Widgets - `listening_text` (string, optional, nullable) — Der anzuzeigende Text, wenn der Agent zuhört - `speaking_text` (string, optional, nullable) — Der anzuzeigende Text, wenn der Agent spricht - `shareable_page_text` (string, optional, nullable) — Der beim Teilen anzuzeigende Text - `shareable_page_show_terms` (boolean, optional, default: true) — Ob die Geschäftsbedingungen auf der teilbaren Seite angezeigt werden sollen - `terms_text` (string, optional, nullable) — Der für die Allgemeinen Geschäftsbedingungen anzuzeigende Text - `terms_html` (string, optional, nullable) — Das HTML zur Anzeige der Allgemeinen Geschäftsbedingungen - `terms_key` (string, optional, nullable) — Der anzuzeigende Schlüssel für die Allgemeinen Geschäftsbedingungen - `show_avatar_when_collapsed` (boolean, optional, nullable, default: false) — Ob der Avatar angezeigt werden soll, wenn das Widget eingeklappt ist - `disable_banner` (boolean, optional, default: false) — Ob das Banner deaktiviert werden soll. - `override_link` (string, optional, nullable) — Der Überschreibungslink für das Widget - `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Liste zulässiger Hostnamen für anklickbare Markdown-Links. Verwenden Sie \{ hostname: '\*' }, um jede Domain zuzulassen. Leer bedeutet, dass keine Links zulässig sind. - `markdown_link_include_www` (boolean, optional, default: true) — Ob www.-Varianten zulässiger Hosts automatisch einbezogen werden sollen. - `markdown_link_allow_http` (boolean, optional, default: true) — Ob zusätzlich zu https:// auch http:// für zulässige Hosts erlaubt werden soll. - `mic_muting_enabled` (boolean, optional, default: true) — Ob das Stummschalten des Mikrofons aktiviert werden soll. - `transcript_enabled` (boolean, optional, default: true) — Ob das Widget das Gesprächstranskript während des Gesprächs anzeigen soll. - `text_input_enabled` (boolean, optional, default: true) — Ob der Nutzer Textnachrichten senden können soll. - `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Ob der Umschalter für den Gesprächsmodus im Widget aktiviert werden soll. - `default_expanded` (boolean, optional, default: false) — Ob das Widget standardmäßig erweitert sein soll. - `always_expanded` (boolean, optional, default: false) — Ob das Widget immer erweitert sein soll. - `dismissible` (boolean, optional, default: false) — Ob der Nutzer das Widget schließen kann. - `show_agent_status` (boolean, optional, default: false) — Ob der Status „in Bearbeitung“, „abgeschlossen“ oder „Fehler“ des Agenten während der Tool-Nutzung angezeigt werden soll - `show_conversation_id` (boolean, optional, default: true) — Ob die Gesprächs-ID nach dem Trennen angezeigt werden soll. - `strip_audio_tags` (boolean, optional, default: true) — Ob Audio-Markup aus Nachrichten entfernt werden soll. - `syntax_highlight_theme` (enum, optional, nullable) — Theme für die Syntaxhervorhebung in Codeblöcken. Wenn nicht festgelegt, verwendet das Widget automatisch die Erkennung. - Allowed values: `light`, `dark` - `text_contents` (WidgetTextContents, optional) — Textinhalte des Widgets - `styles` (WidgetStyles, optional) — Stile für das Widget - `show_resize_button` (boolean, optional, default: true) — Ob die Schaltfläche zum Ändern der Größe angezeigt werden soll - `end_confirmation_enabled` (boolean, optional, default: false) — Ob der Benutzer vor dem Beenden eines Chats oder Anrufs um Bestätigung gebeten werden soll - `supported_language_overrides` (list of string, optional, nullable) - `language_presets` (map from string to WidgetLanguagePresetResponse, optional) — Sprachvoreinstellungen für das Widget - `text_only` (boolean, optional, default: false) — Gibt an, ob der Agent den reinen Textmodus verwendet. - `supports_text_only` (boolean, optional, default: false) — Gibt an, ob der Agent in den reinen Textmodus wechseln kann. - `first_message` (string, optional, nullable) - `use_rtc` (boolean, optional, nullable) — Ob WebRTC für Gesprächsverbindungen verwendet werden soll - `file_input_config` (FileInputConfig, optional) — Konfiguration für den Datei-Upload im Widget ### ValidationError - `loc` (list of ValidationErrorLocItems, required) - `msg` (string, required) - `type` (string, required) ### WidgetConfigResponseModelAvatar Der Avatar des Widgets ### WidgetEndFeedbackConfig - `type` (enum, optional, default: rating) — Der Typ des Feedbacks, das am Ende der Unterhaltung erfasst wird - Allowed values: `rating` ### AllowlistItem - `hostname` (string, required) — Der Hostname des zulässigen Ursprungs ### WidgetTextContents - `main_label` (string, optional, nullable) — Call-to-Action, der in der kompakten und der vollständigen Variante angezeigt wird. - `start_call` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Starten eines Anrufs. - `start_chat` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Starten eines Chats (nur Text) - `new_call` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche für einen neuen Anruf. Wird angezeigt, wenn der Anrufer bereits mindestens einen Anruf beendet hat, um den nächsten zu starten. - `end_call` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Beenden des Anrufs. - `mute_microphone` (string, optional, nullable) — ARIA-Label für die Schaltfläche zum Stummschalten des Mikrofons. - `change_language` (string, optional, nullable) — ARIA-Label für das Dropdown-Menü zum Ändern der Sprache. - `collapse` (string, optional, nullable) — ARIA-Label für die Schaltfläche zum Einklappen. - `expand` (string, optional, nullable) — ARIA-Label für die Schaltfläche zum Ausklappen. - `copied` (string, optional, nullable) — Text, der angezeigt wird, wenn der Nutzer über die Kopierschaltfläche einen Wert kopiert. - `accept_terms` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Akzeptieren der Bedingungen. - `dismiss_terms` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Abbrechen der Bedingungen. - `listening_status` (string, optional, nullable) — Angezeigter Status, wenn der Agent zuhört. - `speaking_status` (string, optional, nullable) — Angezeigter Status, wenn der Agent spricht. - `connecting_status` (string, optional, nullable) — Angezeigter Status, wenn der Agent eine Verbindung herstellt. - `chatting_status` (string, optional, nullable) — Angezeigter Status, wenn der Agent chattet (nur Text) - `queue_waiting_status` (string, optional, nullable) — Status, der während des Wartens in der Warteschlange auf einen verfügbaren Agenten angezeigt wird. - `queue_waiting_status_short` (string, optional, nullable) — Kurzer Status, der während des Wartens auf einen verfügbaren Agenten angezeigt wird. - `input_label` (string, optional, nullable) — ARIA-Label für das Texteingabefeld. - `input_placeholder` (string, optional, nullable) — Platzhaltertext für die Texteingabe. - `input_placeholder_text_only` (string, optional, nullable) — Platzhaltertext für die Texteingabe (nur Text) - `input_placeholder_new_conversation` (string, optional, nullable) — Platzhaltertext für die Texteingabe beim Start einer neuen Unterhaltung (nur Text) - `user_ended_conversation` (string, optional, nullable) — Informationsnachricht, die angezeigt wird, wenn der Nutzer das Gespräch beendet. - `agent_ended_conversation` (string, optional, nullable) — Informationsnachricht, die angezeigt wird, wenn der Agent das Gespräch beendet. - `conversation_id` (string, optional, nullable) — Textlabel neben der Gesprächs-ID. - `error_occurred` (string, optional, nullable) — Textlabel, das bei einem Fehler verwendet wird. - `queue_timed_out` (string, optional, nullable) — Fehlermeldung, die bei Ablauf der Wartezeit in der Warteschlange angezeigt wird. - `copy_id` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Kopieren der ID. - `initiate_feedback` (string, optional, nullable) — Text, der angezeigt wird, um den Nutzer um Feedback zu bitten. - `request_follow_up_feedback` (string, optional, nullable) — Text, der angezeigt wird, um zusätzliche Feedback-Details anzufordern. - `thanks_for_feedback` (string, optional, nullable) — Text, der angezeigt wird, um dem Nutzer für sein Feedback zu danken. - `thanks_for_feedback_details` (string, optional, nullable) — Zusätzlicher angezeigter Text, der den Nutzen von Nutzerfeedback erläutert. - `follow_up_feedback_placeholder` (string, optional, nullable) — Platzhaltertext für das Eingabefeld für anschließendes Feedback. - `submit` (string, optional, nullable) — Text und ARIA-Label für die Absenden-Schaltfläche. - `go_back` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche „Zurück“. - `send_message` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Senden einer Nachricht. - `text_mode` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Wechseln in den Textmodus. - `voice_mode` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Wechseln in den Sprachmodus. - `switched_to_text_mode` (string, optional, nullable) — Beim Wechsel in den Textmodus angezeigte Toast-Benachrichtigung. - `switched_to_voice_mode` (string, optional, nullable) — Beim Wechsel in den Sprachmodus angezeigte Toast-Benachrichtigung. - `copy` (string, optional, nullable) — Text und ARIA-Label für die Kopierschaltfläche. - `download` (string, optional, nullable) — Text und ARIA-Label für die Download-Schaltfläche. - `wrap` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Umschalten des Zeilenumbruchs. - `agent_working` (string, optional, nullable) — Statustext, der angezeigt wird, während der Agent einen Tool-Aufruf verarbeitet. - `agent_done` (string, optional, nullable) — Statustext, der angezeigt wird, wenn der Agent die Verarbeitung eines Tool-Aufrufs abschließt. - `agent_error` (string, optional, nullable) — Statustext, der angezeigt wird, wenn beim Tool-Aufruf des Agents ein Fehler auftritt. - `attach_file` (string, optional, nullable) — Text und ARIA-Label für die Schaltfläche zum Anhängen einer Datei. - `remove_file` (string, optional, nullable) — ARIA-Label für die Schaltfläche zum Entfernen der Datei. - `file_upload_error` (string, optional, nullable) — Fehlermeldung, die angezeigt wird, wenn das Hochladen einer Datei fehlschlägt. - `file_type_unsupported` (string, optional, nullable) — Fehlermeldung, die angezeigt wird, wenn ein nicht unterstützter Dateityp ausgewählt wurde. Anschließend folgt die Liste der akzeptierten Typen. - `file_too_large` (string, optional, nullable) — Fehlermeldung, die angezeigt wird, wenn eine Datei die maximale Größenbeschränkung überschreitet. - `file_limit_reached` (string, optional, nullable) — Fehlermeldung, die angezeigt wird, wenn die maximale Anzahl von Dateien für ein Gespräch erreicht ist. - `typing_indicator` (string, optional, nullable) — Statustext, der angezeigt wird, während der Agent schreibt. - `rich_content_unavailable` (string, optional, nullable) — Ersatzmeldung, die angezeigt wird, wenn Rich Content nicht gerendert werden kann. ### WidgetStyles - `base` (string, optional, nullable) — Die Basis-Hintergrundfarbe. - `base_hover` (string, optional, nullable) — Die Farbe des Basis-Hintergrunds beim Darüberfahren. - `base_active` (string, optional, nullable) — Die Farbe des Basis-Hintergrunds im aktiven Zustand (geklickt). - `base_border` (string, optional, nullable) — Die Farbe des Rahmens vor dem Basis-Hintergrund. - `base_subtle` (string, optional, nullable) — Die Farbe des dezenten Texts vor dem Basis-Hintergrund. - `base_primary` (string, optional, nullable) — Die Farbe des primären Texts vor dem Basis-Hintergrund. - `base_error` (string, optional, nullable) — Die Farbe von Fehlertext vor dem Basis-Hintergrund. - `accent` (string, optional, nullable) — Die Akzent-Hintergrundfarbe. - `accent_hover` (string, optional, nullable) — Die Farbe des Akzenthintergrunds beim Darüberfahren. - `accent_active` (string, optional, nullable) — Die Farbe des Akzenthintergrunds im aktiven Zustand (geklickt). - `accent_border` (string, optional, nullable) — Die Farbe des Rahmens vor dem Akzenthintergrund. - `accent_subtle` (string, optional, nullable) — Die Farbe des dezenten Texts vor dem Akzenthintergrund. - `accent_primary` (string, optional, nullable) — Die Farbe des primären Texts vor dem Akzenthintergrund. - `overlay_padding` (double, optional, nullable) — Der Innenabstand an den Rändern des Viewports. - `button_radius` (double, optional, nullable) — Der Radius der Schaltflächen. - `input_radius` (double, optional, nullable) — Der Radius der Eingabefelder. - `bubble_radius` (double, optional, nullable) — Der Radius der Chatblasen. - `sheet_radius` (double, optional, nullable) — Der Standardradius von Sheets. - `compact_sheet_radius` (double, optional, nullable) — Der Radius des Bereichs im kompakten Modus. - `dropdown_sheet_radius` (double, optional, nullable) — Der Radius des Dropdown-Bereichs. ### WidgetLanguagePresetResponse - `first_message` (string, optional, nullable) - `text_contents` (WidgetTextContents, optional, nullable) — Der Textinhalt für die ausgewählte Sprache - `terms_text` (string, optional, nullable) — Der in dieser Sprache für die Allgemeinen Geschäftsbedingungen anzuzeigende Text - `terms_html` (string, optional, nullable) — Das HTML zur Anzeige der Allgemeinen Geschäftsbedingungen in dieser Sprache - `terms_key` (string, optional, nullable) — Der anzuzeigende Schlüssel für die Allgemeinen Geschäftsbedingungen in dieser Sprache ### FileInputConfig - `enabled` (boolean, optional, default: true) — Wenn aktiviert, können Nutzer im Chat Bilder, PDFs oder Textdateien anhängen, sofern das LLM multimodale Eingaben unterstützt. - `max_files_in_memory` (integer, optional, default: 10) — Anzahl der zuletzt verwendeten Dateien, die während einer Unterhaltung im Speicher bleiben. Ältere Dateien werden zusammengefasst und ihr Speicher wird freigegeben. - `max_files_per_conversation` (integer, optional, default: 10) — Gesamtzahl der Dateien, die ein Nutzer in einer Unterhaltung hochladen kann. Uploads werden pro Datei abgerechnet. Verwenden Sie -1 für kein Limit oder einen Wert >= max_files_in_memory. ### ValidationErrorLocItems ### OrbAvatar - `type` ("orb", optional, default: orb) — Der Typ des Avatars - `color_1` (string, optional, default: #2792dc) — Die erste Farbe des Avatars - `color_2` (string, optional, default: #9ce6e6) — Die zweite Farbe des Avatars ### URLAvatar - `type` ("url", optional, default: url) — Der Typ des Avatars - `custom_url` (string, optional, default: ) — Die benutzerdefinierte URL des Avatars ### ImageAvatar - `type` ("image", optional, default: image) — Der Typ des Avatars - `url` (string, optional, default: ) — Die URL des Avatars ## Examples **Response** ```json { "agent_id": "string", "widget_config": { "language": "en", "supported_language_overrides": [ "es", "fr" ], "language_presets": {}, "text_only": false, "supports_text_only": true, "first_message": "Hello! How can I help you today?", "use_rtc": false, "file_input_config": { "enabled": false, "max_files_in_memory": 10, "max_files_per_conversation": 10 } } } ``` **SDK Code** ```python import requests url = "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget" response = requests.get(url) print(response.json()) ``` ```javascript const url = 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget'; const options = {method: 'GET'}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget" req, _ := http.NewRequest("GET", url, nil) res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget") .asString(); ``` ```php request('GET', 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget'); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget"); var request = new RestRequest(Method.GET); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let request = NSMutableURLRequest(url: NSURL(string: "https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```