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

# Recupera configurazione del widget dell'agente

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

Recupera la configurazione del widget per un agente

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) — L'ID di un agente. Viene restituito alla creazione dell'agente.

### Query parameters

- `conversation_signature` (string, optional, nullable) — Un token con scadenza che consente di avviare una conversazione websocket. Può essere generato per un agente usando l'endpoint /v1/convai/conversation/get_signed_url

## Response

### 200

Risposta riuscita

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

## Errors

### 422 Unprocessable Entity Error

Errore di convalida

- `detail` (list of ValidationError, optional)

## Types

### WidgetConfigResponseModel

- `language` (string, required)
- `variant` (enum, optional, default: full) — La variante del widget
  - Allowed values: `tiny`, `compact`, `full`, `expandable`
- `placement` (enum, optional, default: bottom-right) — La posizione del widget sullo schermo
  - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right`
- `expandable` (enum, optional, default: never) — Indica se il widget è espandibile
  - Allowed values: `never`, `mobile`, `desktop`, `always`
- `avatar` (WidgetConfigResponseModelAvatar, optional) — L'avatar del widget
- `feedback_mode` (enum, optional, default: none) — La modalità di feedback del widget
  - Allowed values: `none`, `during`, `end`
- `end_feedback` (WidgetEndFeedbackConfig, optional, nullable) — Configurazione per il feedback raccolto al termine della conversazione
- `bg_color` (string, optional, default: #ffffff) — Il colore di sfondo del widget
- `text_color` (string, optional, default: #000000) — Il colore del testo del widget
- `btn_color` (string, optional, default: #000000) — Il colore del pulsante del widget
- `btn_text_color` (string, optional, default: #ffffff) — Il colore del testo del pulsante del widget
- `border_color` (string, optional, default: #e1e1e1) — Il colore del bordo del widget
- `focus_color` (string, optional, default: #000000) — Il colore di focus del widget
- `border_radius` (integer, optional, nullable) — Il raggio del bordo del widget
- `btn_radius` (integer, optional, nullable) — Il raggio del pulsante del widget
- `action_text` (string, optional, nullable) — Il testo dell'azione del widget
- `start_call_text` (string, optional, nullable) — Il testo di avvio della chiamata del widget
- `end_call_text` (string, optional, nullable) — Il testo di fine chiamata del widget
- `expand_text` (string, optional, nullable) — Il testo di espansione del widget
- `listening_text` (string, optional, nullable) — Il testo da visualizzare quando l'agente è in ascolto
- `speaking_text` (string, optional, nullable) — Il testo da visualizzare quando l'agente sta parlando
- `shareable_page_text` (string, optional, nullable) — Il testo da visualizzare durante la condivisione
- `shareable_page_show_terms` (boolean, optional, default: true) — Indica se mostrare termini e condizioni nella pagina condivisibile
- `terms_text` (string, optional, nullable) — Il testo da visualizzare per i termini e le condizioni
- `terms_html` (string, optional, nullable) — L'HTML da visualizzare per i termini e le condizioni
- `terms_key` (string, optional, nullable) — La chiave da visualizzare per i termini e le condizioni
- `show_avatar_when_collapsed` (boolean, optional, nullable, default: false) — Indica se mostrare l'avatar quando il widget è compresso
- `disable_banner` (boolean, optional, default: false) — Indica se disabilitare il banner
- `override_link` (string, optional, nullable) — Il link di override per il widget
- `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Elenco degli hostname consentiti per i link Markdown cliccabili. Usa \{ hostname: '\*' } per consentire qualsiasi dominio. Se vuoto, non è consentito alcun link.
- `markdown_link_include_www` (boolean, optional, default: true) — Indica se includere automaticamente le varianti www. degli host consentiti
- `markdown_link_allow_http` (boolean, optional, default: true) — Indica se consentire http:// oltre a https:// per gli host consentiti
- `mic_muting_enabled` (boolean, optional, default: true) — Indica se abilitare il silenziamento del microfono
- `transcript_enabled` (boolean, optional, default: true) — Indica se il widget deve mostrare la trascrizione della conversazione durante lo svolgimento
- `text_input_enabled` (boolean, optional, default: true) — Se l'utente deve poter inviare messaggi di testo
- `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Indica se abilitare nel widget l'interruttore della modalità di conversazione
- `default_expanded` (boolean, optional, default: false) — Indica se il widget deve essere espanso per impostazione predefinita
- `always_expanded` (boolean, optional, default: false) — Indica se il widget deve essere sempre espanso
- `dismissible` (boolean, optional, default: false) — Indica se l'utente può chiudere il widget
- `show_agent_status` (boolean, optional, default: false) — Indica se mostrare lo stato dell'agente (in elaborazione/completato/errore) durante l'uso degli strumenti
- `show_conversation_id` (boolean, optional, default: true) — Indica se mostrare l'ID della conversazione dopo la disconnessione.
- `strip_audio_tags` (boolean, optional, default: true) — Indica se rimuovere il markup audio dai messaggi.
- `syntax_highlight_theme` (enum, optional, nullable) — Tema per l'evidenziazione della sintassi nei blocchi di codice. Se non impostato, il widget rileva automaticamente il tema.
  - Allowed values: `light`, `dark`
- `text_contents` (WidgetTextContents, optional) — Contenuti testuali del widget
- `styles` (WidgetStyles, optional) — Stili del widget
- `show_resize_button` (boolean, optional, default: true) — Indica se mostrare il pulsante di ridimensionamento
- `supported_language_overrides` (list of string, optional, nullable)
- `language_presets` (map from string to WidgetLanguagePresetResponse, optional) — Preimpostazioni della lingua per il widget
- `text_only` (boolean, optional, default: false) — Se l'agente usa la modalità solo testo
- `supports_text_only` (boolean, optional, default: false) — Se l'agente può essere impostato sulla modalità solo testo
- `first_message` (string, optional, nullable)
- `use_rtc` (boolean, optional, nullable) — Indica se usare WebRTC per le connessioni delle conversazioni
- `file_input_config` (FileInputConfig, optional) — Configurazione per il caricamento di file nel widget

### ValidationError

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

### WidgetConfigResponseModelAvatar

L'avatar del widget

### WidgetEndFeedbackConfig

- `type` (enum, optional, default: rating) — Il tipo di feedback da raccogliere al termine della conversazione
  - Allowed values: `rating`

### AllowlistItem

- `hostname` (string, required) — Il nome host dell'origine consentita

### WidgetTextContents

- `main_label` (string, optional, nullable) — Call to action visualizzata nelle varianti compatta e completa.
- `start_call` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di avvio della chiamata.
- `start_chat` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di avvio della chat (solo testo)
- `new_call` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante Nuova chiamata. Visualizzato quando il chiamante ha già terminato almeno una chiamata per avviare quella successiva.
- `end_call` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di fine chiamata.
- `mute_microphone` (string, optional, nullable) — Etichetta ARIA per il pulsante per disattivare il microfono.
- `change_language` (string, optional, nullable) — Etichetta ARIA per il menu a discesa di cambio lingua.
- `collapse` (string, optional, nullable) — Etichetta ARIA per il pulsante per comprimere.
- `expand` (string, optional, nullable) — Etichetta ARIA per il pulsante per espandere.
- `copied` (string, optional, nullable) — Testo visualizzato quando l'utente copia un valore tramite il pulsante di copia.
- `accept_terms` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di accettazione dei termini.
- `dismiss_terms` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di annullamento dei termini.
- `listening_status` (string, optional, nullable) — Stato visualizzato quando l'agente è in ascolto.
- `speaking_status` (string, optional, nullable) — Stato visualizzato quando l'agente sta parlando.
- `connecting_status` (string, optional, nullable) — Stato visualizzato quando l'agente si sta connettendo.
- `chatting_status` (string, optional, nullable) — Stato visualizzato quando l'agente sta chattando, solo testo
- `queue_waiting_status` (string, optional, nullable) — Stato visualizzato durante l'attesa nella coda di un agente disponibile.
- `queue_waiting_status_short` (string, optional, nullable) — Breve stato visualizzato durante l'attesa di un agente disponibile.
- `input_label` (string, optional, nullable) — Etichetta ARIA per l'input del messaggio di testo.
- `input_placeholder` (string, optional, nullable) — Testo segnaposto per il campo di inserimento del messaggio di testo.
- `input_placeholder_text_only` (string, optional, nullable) — Testo segnaposto per il campo di inserimento del messaggio di testo (solo testo)
- `input_placeholder_new_conversation` (string, optional, nullable) — Testo segnaposto per il campo di inserimento del messaggio di testo quando si avvia una nuova conversazione (solo testo)
- `user_ended_conversation` (string, optional, nullable) — Messaggio informativo visualizzato quando l'utente termina la conversazione.
- `agent_ended_conversation` (string, optional, nullable) — Messaggio informativo visualizzato quando l'agente termina la conversazione.
- `conversation_id` (string, optional, nullable) — Etichetta di testo usata accanto all'ID della conversazione.
- `error_occurred` (string, optional, nullable) — Etichetta di testo usata quando si verifica un errore.
- `queue_timed_out` (string, optional, nullable) — Messaggio di errore visualizzato quando scade il tempo di attesa nella coda.
- `copy_id` (string, optional, nullable) — Testo ed etichetta ARIA usati per il pulsante di copia dell'ID.
- `initiate_feedback` (string, optional, nullable) — Testo visualizzato per chiedere un feedback all'utente.
- `request_follow_up_feedback` (string, optional, nullable) — Testo visualizzato per richiedere ulteriori dettagli sul feedback.
- `thanks_for_feedback` (string, optional, nullable) — Testo visualizzato per ringraziare l'utente per il feedback fornito.
- `thanks_for_feedback_details` (string, optional, nullable) — Testo aggiuntivo visualizzato che spiega il valore del feedback degli utenti.
- `follow_up_feedback_placeholder` (string, optional, nullable) — Testo segnaposto per il campo di inserimento del feedback successivo.
- `submit` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di invio.
- `go_back` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante Indietro.
- `send_message` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di invio del messaggio.
- `text_mode` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di passaggio alla modalità testo.
- `voice_mode` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di passaggio alla modalità vocale.
- `switched_to_text_mode` (string, optional, nullable) — Notifica toast visualizzata quando si passa alla modalità testo.
- `switched_to_voice_mode` (string, optional, nullable) — Notifica toast visualizzata quando si passa alla modalità vocale.
- `copy` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di copia.
- `download` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di download.
- `wrap` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di attivazione/disattivazione dell'a capo automatico.
- `agent_working` (string, optional, nullable) — Testo di stato visualizzato mentre l'agente elabora una chiamata allo strumento.
- `agent_done` (string, optional, nullable) — Testo di stato visualizzato quando l'agente termina l'elaborazione di una chiamata allo strumento.
- `agent_error` (string, optional, nullable) — Testo di stato visualizzato quando l'agente rileva un errore durante una chiamata allo strumento.
- `attach_file` (string, optional, nullable) — Testo ed etichetta ARIA per il pulsante di allegamento file.
- `remove_file` (string, optional, nullable) — Etichetta ARIA per il pulsante per rimuovere il file.
- `file_upload_error` (string, optional, nullable) — Messaggio di errore visualizzato quando il caricamento di un file non riesce.
- `file_type_unsupported` (string, optional, nullable) — Messaggio di errore visualizzato quando viene selezionato un tipo di file non supportato. Seguito dall'elenco dei tipi accettati.
- `file_too_large` (string, optional, nullable) — Messaggio di errore visualizzato quando un file supera il limite di dimensione massima.
- `file_limit_reached` (string, optional, nullable) — Messaggio di errore visualizzato quando viene raggiunto il numero massimo di file per una conversazione.
- `typing_indicator` (string, optional, nullable) — Testo di stato visualizzato mentre l'agente sta scrivendo.
- `rich_content_unavailable` (string, optional, nullable) — Messaggio di fallback visualizzato quando non è possibile eseguire il rendering dei contenuti avanzati.

### WidgetStyles

- `base` (string, optional, nullable) — Il colore di sfondo di base.
- `base_hover` (string, optional, nullable) — Il colore dello sfondo di base al passaggio del mouse.
- `base_active` (string, optional, nullable) — Il colore dello sfondo di base quando è attivo (cliccato).
- `base_border` (string, optional, nullable) — Il colore del bordo sullo sfondo di base.
- `base_subtle` (string, optional, nullable) — Il colore del testo secondario sullo sfondo di base.
- `base_primary` (string, optional, nullable) — Il colore del testo principale sullo sfondo di base.
- `base_error` (string, optional, nullable) — Il colore del testo di errore sullo sfondo di base.
- `accent` (string, optional, nullable) — Il colore di sfondo dell'accento.
- `accent_hover` (string, optional, nullable) — Il colore dello sfondo in risalto al passaggio del mouse.
- `accent_active` (string, optional, nullable) — Il colore dello sfondo in risalto quando è attivo (cliccato).
- `accent_border` (string, optional, nullable) — Il colore del bordo sullo sfondo in risalto.
- `accent_subtle` (string, optional, nullable) — Il colore del testo secondario sullo sfondo in risalto.
- `accent_primary` (string, optional, nullable) — Il colore del testo principale sullo sfondo dell'accento.
- `overlay_padding` (double, optional, nullable) — Il padding attorno ai bordi del viewport.
- `button_radius` (double, optional, nullable) — Il raggio dei pulsanti.
- `input_radius` (double, optional, nullable) — Il raggio dei campi di input.
- `bubble_radius` (double, optional, nullable) — Il raggio delle bolle della chat.
- `sheet_radius` (double, optional, nullable) — Il raggio predefinito dei fogli.
- `compact_sheet_radius` (double, optional, nullable) — Il raggio del pannello in modalità compatta.
- `dropdown_sheet_radius` (double, optional, nullable) — Il raggio del pannello a discesa.

### WidgetLanguagePresetResponse

- `first_message` (string, optional, nullable)
- `text_contents` (WidgetTextContents, optional, nullable) — Il contenuto testuale per la lingua selezionata
- `terms_text` (string, optional, nullable) — Il testo da visualizzare per i termini e le condizioni in questa lingua
- `terms_html` (string, optional, nullable) — L'HTML da visualizzare per i termini e le condizioni in questa lingua
- `terms_key` (string, optional, nullable) — La chiave da visualizzare per i termini e le condizioni in questa lingua

### FileInputConfig

- `enabled` (boolean, optional, default: true) — Quando è abilitata, gli utenti possono allegare immagini o PDF nella chat se l'LLM supporta input multimodali.
- `max_files_in_memory` (integer, optional, default: 10) — Numero di file più recenti mantenuti in memoria durante una conversazione. I file meno recenti vengono riepilogati e la relativa memoria viene liberata.
- `max_files_per_conversation` (integer, optional, default: 10) — Numero totale di file che un utente può caricare in una conversazione. I caricamenti sono fatturati per file. Usa -1 per nessun limite oppure un valore >= max_files_in_memory.

### ValidationErrorLocItems

### OrbAvatar

- `type` ("orb", optional, default: orb) — Il tipo di avatar
- `color_1` (string, optional, default: #2792dc) — Il primo colore dell'avatar
- `color_2` (string, optional, default: #9ce6e6) — Il secondo colore dell'avatar

### URLAvatar

- `type` ("url", optional, default: url) — Il tipo di avatar
- `custom_url` (string, optional, default: ) — L'URL personalizzato dell'avatar

### ImageAvatar

- `type` ("image", optional, default: image) — Il tipo di avatar
- `url` (string, optional, default: ) — L'URL dell'avatar

## 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()
```