> 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.

# Pobierz konfigurację widżetu agenta

GET https://api.elevenlabs.io/v1/convai/agents/{agent_id}/widget

Pobierz konfigurację widżetu agenta

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) — ID agenta. Jest zwracane przy tworzeniu agenta.

### Query parameters

- `conversation_signature` (string, optional, nullable) — Wygasający token umożliwiający rozpoczęcie rozmowy przez WebSocket. Można go wygenerować dla agenta za pomocą endpointu /v1/convai/conversation/get_signed_url

## Response

### 200

Pomyślna odpowiedź

- `agent_id` (string, required)
- `widget_config` (WidgetConfigResponseModel, required)

## Errors

### 422 Unprocessable Entity Error

Błąd walidacji

- `detail` (list of ValidationError, optional)

## Types

### WidgetConfigResponseModel

- `language` (string, required)
- `variant` (enum, optional, default: full) — Wariant widżetu
  - Allowed values: `tiny`, `compact`, `full`, `expandable`
- `placement` (enum, optional, default: bottom-right) — Położenie widżetu na ekranie
  - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right`
- `expandable` (enum, optional, default: never) — Czy widżet można rozwinąć
  - Allowed values: `never`, `mobile`, `desktop`, `always`
- `avatar` (WidgetConfigResponseModelAvatar, optional) — Awatar widżetu
- `feedback_mode` (enum, optional, default: none) — Tryb opinii widżetu
  - Allowed values: `none`, `during`, `end`
- `end_feedback` (WidgetEndFeedbackConfig, optional, nullable) — Konfiguracja opinii zbieranych na końcu rozmowy
- `bg_color` (string, optional, default: #ffffff) — Kolor tła widżetu
- `text_color` (string, optional, default: #000000) — Kolor tekstu widżetu
- `btn_color` (string, optional, default: #000000) — Kolor przycisku widżetu
- `btn_text_color` (string, optional, default: #ffffff) — Kolor tekstu przycisku widżetu
- `border_color` (string, optional, default: #e1e1e1) — Kolor obramowania widżetu
- `focus_color` (string, optional, default: #000000) — Kolor aktywnego elementu widżetu
- `border_radius` (integer, optional, nullable) — Promień zaokrąglenia obramowania widżetu
- `btn_radius` (integer, optional, nullable) — Promień zaokrąglenia przycisku widżetu
- `action_text` (string, optional, nullable) — Tekst działania widżetu
- `start_call_text` (string, optional, nullable) — Tekst rozpoczynający rozmowę w widżecie
- `end_call_text` (string, optional, nullable) — Tekst zakończenia rozmowy widżetu
- `expand_text` (string, optional, nullable) — Tekst rozwinięcia widżetu
- `listening_text` (string, optional, nullable) — Tekst wyświetlany, gdy agent słucha
- `speaking_text` (string, optional, nullable) — Tekst wyświetlany, gdy agent mówi
- `shareable_page_text` (string, optional, nullable) — Tekst wyświetlany podczas udostępniania
- `shareable_page_show_terms` (boolean, optional, default: true) — Czy pokazywać regulamin na stronie do udostępniania
- `terms_text` (string, optional, nullable) — Tekst wyświetlany w regulaminie
- `terms_html` (string, optional, nullable) — HTML do wyświetlenia dla regulaminu
- `terms_key` (string, optional, nullable) — Klucz do wyświetlania regulaminu
- `show_avatar_when_collapsed` (boolean, optional, nullable, default: false) — Czy pokazywać awatar, gdy widżet jest zwinięty
- `disable_banner` (boolean, optional, default: false) — Czy wyłączyć baner
- `override_link` (string, optional, nullable) — Link zastępujący dla widżetu
- `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Lista dozwolonych nazw hostów dla klikalnych linków Markdown. Użyj \{ hostname: '\*' }, aby zezwolić na dowolną domenę. Pusta lista oznacza, że żadne linki nie są dozwolone.
- `markdown_link_include_www` (boolean, optional, default: true) — Czy automatycznie uwzględniać warianty www. dozwolonych hostów
- `markdown_link_allow_http` (boolean, optional, default: true) — Czy zezwolić na http:// obok https:// dla dozwolonych hostów
- `mic_muting_enabled` (boolean, optional, default: true) — Czy włączyć wyciszanie mikrofonu
- `transcript_enabled` (boolean, optional, default: true) — Czy widżet powinien wyświetlać transkrypcję rozmowy w jej trakcie
- `text_input_enabled` (boolean, optional, default: true) — Czy użytkownik może wysyłać wiadomości tekstowe
- `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Czy włączyć przełącznik trybu rozmowy w widżecie
- `default_expanded` (boolean, optional, default: false) — Czy widżet powinien być domyślnie rozwinięty
- `always_expanded` (boolean, optional, default: false) — Czy widżet powinien być zawsze rozwinięty
- `dismissible` (boolean, optional, default: false) — Czy użytkownik może zamknąć widżet
- `show_agent_status` (boolean, optional, default: false) — Czy pokazywać status agenta: w trakcie/gotowe/błąd podczas używania narzędzia
- `show_conversation_id` (boolean, optional, default: true) — Czy pokazywać identyfikator rozmowy po rozłączeniu.
- `strip_audio_tags` (boolean, optional, default: true) — Czy usuwać znaczniki audio z wiadomości.
- `syntax_highlight_theme` (enum, optional, nullable) — Motyw podświetlania składni w blokach kodu. Jeśli nie jest ustawiony, widżet automatycznie go wykrywa.
  - Allowed values: `light`, `dark`
- `text_contents` (WidgetTextContents, optional) — Treść tekstowa widżetu
- `styles` (WidgetStyles, optional) — Style widżetu
- `show_resize_button` (boolean, optional, default: true) — Czy pokazywać przycisk zmiany rozmiaru
- `end_confirmation_enabled` (boolean, optional, default: false) — Czy prosić użytkownika o potwierdzenie przed zakończeniem czatu lub rozmowy
- `supported_language_overrides` (list of string, optional, nullable)
- `language_presets` (map from string to WidgetLanguagePresetResponse, optional) — Ustawienia języka widżetu
- `text_only` (boolean, optional, default: false) — Czy agent używa trybu tylko tekstowego
- `supports_text_only` (boolean, optional, default: false) — Czy agenta można przełączyć w tryb tylko tekstowy
- `first_message` (string, optional, nullable)
- `use_rtc` (boolean, optional, nullable) — Czy używać WebRTC do połączeń rozmów
- `file_input_config` (FileInputConfig, optional) — Konfiguracja przesyłania plików w widżecie

### ValidationError

- `loc` (list of ValidationErrorLocItems, required)
- `msg` (string, required)
- `type` (string, required)

### WidgetConfigResponseModelAvatar

Awatar widżetu

- OrbAvatar: OrbAvatar
- URLAvatar: URLAvatar
- ImageAvatar: ImageAvatar

### WidgetEndFeedbackConfig

- `type` (enum, optional, default: rating) — Typ opinii zbieranej na końcu rozmowy
  - Allowed values: `rating`

### AllowlistItem

- `hostname` (string, required) — Nazwa hosta dozwolonego źródła

### WidgetTextContents

- `main_label` (string, optional, nullable) — Wezwanie do działania wyświetlane w wersji kompaktowej i pełnej.
- `start_call` (string, optional, nullable) — Tekst i etykieta ARIA przycisku rozpoczęcia połączenia.
- `start_chat` (string, optional, nullable) — Tekst i etykieta ARIA przycisku rozpoczęcia czatu (tylko tekst)
- `new_call` (string, optional, nullable) — Tekst i etykieta ARIA przycisku nowego połączenia. Wyświetlane, gdy dzwoniący zakończył już co najmniej jedno połączenie, aby rozpocząć kolejne.
- `end_call` (string, optional, nullable) — Tekst i etykieta ARIA przycisku zakończenia połączenia.
- `mute_microphone` (string, optional, nullable) — Etykieta ARIA dla przycisku wyciszania mikrofonu.
- `change_language` (string, optional, nullable) — Etykieta ARIA dla listy rozwijanej zmiany języka.
- `collapse` (string, optional, nullable) — Etykieta ARIA dla przycisku zwijania.
- `expand` (string, optional, nullable) — Etykieta ARIA dla przycisku rozwijania.
- `copied` (string, optional, nullable) — Tekst wyświetlany, gdy użytkownik kopiuje wartość przyciskiem kopiowania.
- `accept_terms` (string, optional, nullable) — Tekst i etykieta ARIA przycisku akceptacji warunków.
- `dismiss_terms` (string, optional, nullable) — Tekst i etykieta ARIA przycisku anulowania warunków.
- `listening_status` (string, optional, nullable) — Status wyświetlany, gdy agent słucha.
- `speaking_status` (string, optional, nullable) — Status wyświetlany, gdy agent mówi.
- `connecting_status` (string, optional, nullable) — Status wyświetlany, gdy agent się łączy.
- `chatting_status` (string, optional, nullable) — Status wyświetlany, gdy agent prowadzi czat (tylko tekst)
- `queue_waiting_status` (string, optional, nullable) — Status wyświetlany podczas oczekiwania w kolejce na dostępnego agenta.
- `queue_waiting_status_short` (string, optional, nullable) — Krótki status wyświetlany podczas oczekiwania na dostępnego agenta.
- `input_label` (string, optional, nullable) — Etykieta ARIA dla pola wiadomości tekstowej.
- `input_placeholder` (string, optional, nullable) — Tekst zastępczy pola wiadomości tekstowej.
- `input_placeholder_text_only` (string, optional, nullable) — Tekst zastępczy pola wiadomości tekstowej (tylko tekst)
- `input_placeholder_new_conversation` (string, optional, nullable) — Tekst zastępczy pola wiadomości tekstowej przy rozpoczynaniu nowej rozmowy (tylko tekst)
- `user_ended_conversation` (string, optional, nullable) — Komunikat informacyjny wyświetlany, gdy użytkownik kończy rozmowę.
- `agent_ended_conversation` (string, optional, nullable) — Komunikat informacyjny wyświetlany, gdy agent kończy rozmowę.
- `conversation_id` (string, optional, nullable) — Etykieta tekstowa używana obok ID rozmowy.
- `error_occurred` (string, optional, nullable) — Etykieta tekstowa używana w razie błędu.
- `queue_timed_out` (string, optional, nullable) — Komunikat błędu wyświetlany po przekroczeniu czasu oczekiwania w kolejce.
- `copy_id` (string, optional, nullable) — Tekst i etykieta ARIA używane dla przycisku kopiowania ID.
- `initiate_feedback` (string, optional, nullable) — Tekst wyświetlany, aby poprosić użytkownika o opinię.
- `request_follow_up_feedback` (string, optional, nullable) — Tekst wyświetlany, aby poprosić o dodatkowe szczegóły opinii.
- `thanks_for_feedback` (string, optional, nullable) — Tekst wyświetlany, aby podziękować użytkownikowi za opinię.
- `thanks_for_feedback_details` (string, optional, nullable) — Dodatkowy wyświetlany tekst wyjaśniający wartość opinii użytkowników.
- `follow_up_feedback_placeholder` (string, optional, nullable) — Tekst zastępczy pola dodatkowej opinii.
- `submit` (string, optional, nullable) — Tekst i etykieta ARIA przycisku przesyłania.
- `go_back` (string, optional, nullable) — Tekst i etykieta ARIA przycisku powrotu.
- `send_message` (string, optional, nullable) — Tekst i etykieta ARIA przycisku wysyłania wiadomości.
- `text_mode` (string, optional, nullable) — Tekst i etykieta ARIA przycisku przełączania na tryb tekstowy.
- `voice_mode` (string, optional, nullable) — Tekst i etykieta ARIA przycisku przełączania na tryb głosowy.
- `switched_to_text_mode` (string, optional, nullable) — Powiadomienie toast wyświetlane przy przełączaniu na tryb tekstowy.
- `switched_to_voice_mode` (string, optional, nullable) — Powiadomienie toast wyświetlane przy przełączaniu na tryb głosowy.
- `copy` (string, optional, nullable) — Tekst i etykieta ARIA przycisku kopiowania.
- `download` (string, optional, nullable) — Tekst i etykieta ARIA przycisku pobierania.
- `wrap` (string, optional, nullable) — Tekst i etykieta ARIA przycisku przełączania zawijania.
- `agent_working` (string, optional, nullable) — Tekst statusu wyświetlany, gdy agent przetwarza wywołanie narzędzia.
- `agent_done` (string, optional, nullable) — Tekst statusu wyświetlany, gdy agent zakończy przetwarzanie wywołania narzędzia.
- `agent_error` (string, optional, nullable) — Tekst statusu wyświetlany, gdy agent napotka błąd podczas wywołania narzędzia.
- `attach_file` (string, optional, nullable) — Tekst i etykieta ARIA przycisku dołączania pliku.
- `remove_file` (string, optional, nullable) — Etykieta ARIA dla przycisku usuwania pliku.
- `file_upload_error` (string, optional, nullable) — Komunikat błędu wyświetlany, gdy nie uda się przesłać pliku.
- `file_type_unsupported` (string, optional, nullable) — Komunikat błędu wyświetlany po wybraniu nieobsługiwanego typu pliku. Po nim wyświetlana jest lista akceptowanych typów.
- `file_too_large` (string, optional, nullable) — Komunikat błędu wyświetlany, gdy plik przekracza maksymalny rozmiar.
- `file_limit_reached` (string, optional, nullable) — Komunikat błędu wyświetlany po osiągnięciu maksymalnej liczby plików dla rozmowy.
- `typing_indicator` (string, optional, nullable) — Tekst statusu wyświetlany, gdy agent pisze.
- `rich_content_unavailable` (string, optional, nullable) — Komunikat zastępczy wyświetlany, gdy nie można wyrenderować sformatowanej treści.

### WidgetStyles

- `base` (string, optional, nullable) — Bazowy kolor tła.
- `base_hover` (string, optional, nullable) — Kolor bazowego tła po najechaniu kursorem.
- `base_active` (string, optional, nullable) — Kolor bazowego tła, gdy jest aktywne (po kliknięciu).
- `base_border` (string, optional, nullable) — Kolor obramowania na bazowym tle.
- `base_subtle` (string, optional, nullable) — Kolor drugorzędnego tekstu na bazowym tle.
- `base_primary` (string, optional, nullable) — Kolor głównego tekstu na bazowym tle.
- `base_error` (string, optional, nullable) — Kolor tekstu błędu na bazowym tle.
- `accent` (string, optional, nullable) — Kolor tła akcentu.
- `accent_hover` (string, optional, nullable) — Kolor tła akcentowego po najechaniu kursorem.
- `accent_active` (string, optional, nullable) — Kolor tła akcentowego, gdy jest aktywne (po kliknięciu).
- `accent_border` (string, optional, nullable) — Kolor obramowania na tle akcentowym.
- `accent_subtle` (string, optional, nullable) — Kolor drugorzędnego tekstu na tle akcentowym.
- `accent_primary` (string, optional, nullable) — Kolor głównego tekstu na tle akcentowym.
- `overlay_padding` (double, optional, nullable) — Odstęp wokół krawędzi obszaru widoku.
- `button_radius` (double, optional, nullable) — Promień zaokrąglenia przycisków.
- `input_radius` (double, optional, nullable) — Promień zaokrąglenia pól wejściowych.
- `bubble_radius` (double, optional, nullable) — Promień zaokrąglenia dymków czatu.
- `sheet_radius` (double, optional, nullable) — Domyślny promień zaokrąglenia arkuszy.
- `compact_sheet_radius` (double, optional, nullable) — Promień zaokrąglenia panelu w trybie kompaktowym.
- `dropdown_sheet_radius` (double, optional, nullable) — Promień zaokrąglenia panelu rozwijanego.

### WidgetLanguagePresetResponse

- `first_message` (string, optional, nullable)
- `text_contents` (WidgetTextContents, optional, nullable) — Treść tekstu dla wybranego języka
- `terms_text` (string, optional, nullable) — Tekst wyświetlany w regulaminie w tym języku
- `terms_html` (string, optional, nullable) — HTML do wyświetlenia dla regulaminu w tym języku
- `terms_key` (string, optional, nullable) — Klucz do wyświetlania regulaminu w tym języku

### FileInputConfig

- `enabled` (boolean, optional, default: true) — Po włączeniu użytkownicy mogą dołączać w czacie obrazy, pliki PDF lub tekstowe, gdy LLM obsługuje dane multimodalne.
- `max_files_in_memory` (integer, optional, default: 10) — Liczba najnowszych plików przechowywanych w pamięci podczas rozmowy. Starsze pliki są podsumowywane, a ich bajty zwalniane.
- `max_files_per_conversation` (integer, optional, default: 10) — Łączna liczba plików, które użytkownik może przesłać w jednej rozmowie. Opłaty za przesłanie są naliczane za plik. Użyj -1 bez limitu albo wartości >= max_files_in_memory.

### ValidationErrorLocItems

- string
- integer

### OrbAvatar

- `type` ("orb", optional, default: orb) — Typ awatara
- `color_1` (string, optional, default: #2792dc) — Pierwszy kolor awatara
- `color_2` (string, optional, default: #9ce6e6) — Drugi kolor awatara

### URLAvatar

- `type` ("url", optional, default: url) — Typ awatara
- `custom_url` (string, optional, default: ) — Niestandardowy URL awatara

### ImageAvatar

- `type` ("image", optional, default: image) — Typ awatara
- `url` (string, optional, default: ) — URL awatara

## 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<String> response = Unirest.get("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->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()
```