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

# Obtener configuración del widget del agente

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

Obtiene la configuración del widget de un agente

Reference: https://elevenlabs.io/docs/eleven-agents/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) — El ID de un agente. Se devuelve al crear el agente.

### Query parameters

- `conversation_signature` (string, optional) — Un token con caducidad que permite iniciar una conversación por websocket. Se puede generar para un agente mediante la ruta de API /v1/convai/conversation/get_signed_url

## Response

### 200

Respuesta correcta.

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

## Errors

### 422 Widget Get Request Unprocessable Entity Error

Error de validación

- `detail` (list of ValidationError, optional)

## Types

### WidgetConfigResponse

- `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 ubicación del widget en la pantalla
  - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right`
- `expandable` (enum, optional, default: never) — Indica si el widget se puede ampliar
  - Allowed values: `never`, `mobile`, `desktop`, `always`
- `avatar` (WidgetConfigResponseAvatar, optional) — El avatar del widget
- `feedback_mode` (enum, optional, default: none) — El modo de comentarios del widget
  - Allowed values: `none`, `during`, `end`
- `end_feedback` (WidgetEndFeedbackConfig, optional) — Configuración de los comentarios recopilados al final de la conversación
- `bg_color` (string, optional, default: #ffffff) — El color de fondo del widget
- `text_color` (string, optional, default: #000000) — El color del texto del widget.
- `btn_color` (string, optional, default: #000000) — El color del botón del widget
- `btn_text_color` (string, optional, default: #ffffff) — El color del texto del botón del widget
- `border_color` (string, optional, default: #e1e1e1) — El color del borde del widget
- `focus_color` (string, optional, default: #000000) — El color de foco del widget
- `border_radius` (integer, optional) — El radio del borde del widget
- `btn_radius` (integer, optional) — El radio del botón del widget
- `action_text` (string, optional) — El texto de acción del widget.
- `start_call_text` (string, optional) — El texto de inicio de llamada del widget.
- `end_call_text` (string, optional) — El texto de finalización de llamada del widget
- `expand_text` (string, optional) — El texto para expandir del widget
- `listening_text` (string, optional) — El texto que se mostrará cuando el agente esté escuchando
- `speaking_text` (string, optional) — El texto que se mostrará cuando el agente esté hablando
- `shareable_page_text` (string, optional) — El texto que se mostrará al compartir
- `shareable_page_show_terms` (boolean, optional, default: true) — Si se muestran los términos y condiciones en la página compartible
- `terms_text` (string, optional) — El texto que se mostrará para los términos y condiciones
- `terms_html` (string, optional) — El HTML que se mostrará para los términos y condiciones
- `terms_key` (string, optional) — La clave que se debe mostrar para los términos y condiciones
- `show_avatar_when_collapsed` (boolean, optional) — Si se muestra el avatar cuando el widget está contraído
- `disable_banner` (boolean, optional, default: false) — Indica si se debe desactivar el banner
- `override_link` (string, optional) — El enlace de sustitución del widget
- `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Lista de nombres de host permitidos para enlaces de Markdown en los que se puede hacer clic. Usa \{ hostname: '\*' } para permitir cualquier dominio. Si está vacía, no se permite ningún enlace.
- `markdown_link_include_www` (boolean, optional, default: true) — Indica si se deben incluir automáticamente las variantes con www. de los hosts permitidos
- `markdown_link_allow_http` (boolean, optional, default: true) — Indica si se permite http:// además de https:// para los hosts permitidos
- `mic_muting_enabled` (boolean, optional, default: true) — Indica si se debe activar el silenciamiento del micrófono
- `transcript_enabled` (boolean, optional, default: true) — Indica si el widget debe mostrar la transcripción de la conversación a medida que transcurre
- `text_input_enabled` (boolean, optional, default: true) — Indica si el usuario debe poder enviar mensajes de texto
- `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Indica si se debe activar el selector de modo de conversación en el widget
- `default_expanded` (boolean, optional, default: false) — Indica si el widget debe estar ampliado de forma predeterminada
- `always_expanded` (boolean, optional, default: false) — Indica si el widget debe estar siempre ampliado
- `dismissible` (boolean, optional, default: false) — Indica si el usuario puede cerrar el widget
- `show_agent_status` (boolean, optional, default: false) — Si se muestra el estado de trabajo/finalización/error del agente durante el uso de herramientas
- `show_conversation_id` (boolean, optional, default: true) — Si se muestra el ID de la conversación tras la desconexión.
- `strip_audio_tags` (boolean, optional, default: true) — Si se elimina el marcado de audio de los mensajes.
- `syntax_highlight_theme` (enum, optional) — Tema para el resaltado de sintaxis de bloques de código. Si no se configura, el widget detecta el tema automáticamente.
  - Allowed values: `light`, `dark`
- `text_contents` (WidgetTextContents, optional) — Contenido de texto del widget.
- `styles` (WidgetStyles, optional) — Estilos del widget.
- `show_resize_button` (boolean, optional, default: true) — Si se muestra el botón para cambiar el tamaño
- `end_confirmation_enabled` (boolean, optional, default: false) — Indica si se debe pedir al usuario que confirme antes de finalizar un chat o una llamada.
- `supported_language_overrides` (list of string, optional)
- `language_presets` (map from string to WidgetLanguagePresetResponse, optional) — Preajustes de idioma para el widget
- `text_only` (boolean, optional, default: false) — Indica si el agente usa el modo de solo texto.
- `supports_text_only` (boolean, optional, default: false) — Indica si el agente puede cambiarse al modo de solo texto.
- `first_message` (string, optional)
- `use_rtc` (boolean, optional) — Si se usa WebRTC para las conexiones de conversación
- `file_input_config` (FileInputConfig, optional) — Configuración de la subida de archivos en el widget

### ValidationError

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

### WidgetConfigResponseAvatar

El avatar del widget

- `type`: `orb`
  - `color_1` (string, optional, default: #2792dc) — El primer color del avatar
  - `color_2` (string, optional, default: #9ce6e6) — El segundo color del avatar
- `type`: `url`
  - `custom_url` (string, optional, default: ) — La URL personalizada del avatar
- `type`: `image`
  - `url` (string, optional, default: ) — La URL del avatar

### WidgetEndFeedbackConfig

- `type` ("rating", optional) — El tipo de comentarios que se recopilarán al final de la conversación

### AllowlistItem

- `hostname` (string, required) — El nombre de host del origen permitido

### WidgetTextContents

- `main_label` (string, optional) — Llamada a la acción mostrada en las variantes compacta y completa.
- `start_call` (string, optional) — Texto y etiqueta ARIA del botón para iniciar la llamada.
- `start_chat` (string, optional) — Texto y etiqueta ARIA del botón para iniciar el chat (solo texto).
- `new_call` (string, optional) — Texto y etiqueta ARIA del botón para nueva llamada. Se muestra cuando la persona que llama ya ha terminado al menos una llamada para iniciar la siguiente.
- `end_call` (string, optional) — Texto y etiqueta ARIA del botón para finalizar la llamada.
- `mute_microphone` (string, optional) — Etiqueta ARIA del botón para silenciar el micrófono.
- `change_language` (string, optional) — Etiqueta ARIA del menú desplegable para cambiar el idioma.
- `collapse` (string, optional) — Etiqueta ARIA del botón para contraer.
- `expand` (string, optional) — Etiqueta ARIA del botón para expandir.
- `copied` (string, optional) — Texto que se muestra cuando el usuario copia un valor con el botón de copiar.
- `accept_terms` (string, optional) — Texto y etiqueta ARIA del botón para aceptar los términos.
- `dismiss_terms` (string, optional) — Texto y etiqueta ARIA del botón para cancelar los términos.
- `listening_status` (string, optional) — Estado que se muestra cuando el agente está escuchando.
- `speaking_status` (string, optional) — Estado que se muestra cuando el agente está hablando.
- `connecting_status` (string, optional) — Estado que se muestra cuando el agente se está conectando.
- `chatting_status` (string, optional) — Estado que se muestra cuando el agente está chateando (solo texto).
- `queue_waiting_status` (string, optional) — Estado que se muestra mientras se espera en la cola a que haya un agente disponible.
- `queue_waiting_status_short` (string, optional) — Estado breve que se muestra mientras se espera a que haya un agente disponible.
- `input_label` (string, optional) — Etiqueta ARIA del campo de entrada de mensajes de texto.
- `input_placeholder` (string, optional) — Texto de marcador de posición para la entrada de mensajes de texto.
- `input_placeholder_text_only` (string, optional) — Texto de marcador de posición para la entrada de mensajes de texto (solo texto)
- `input_placeholder_new_conversation` (string, optional) — Texto de marcador de posición para la entrada de mensajes de texto al iniciar una conversación nueva (solo texto)
- `user_ended_conversation` (string, optional) — Mensaje informativo que se muestra cuando el usuario finaliza la conversación.
- `agent_ended_conversation` (string, optional) — Mensaje informativo que se muestra cuando el agente finaliza la conversación.
- `conversation_id` (string, optional) — Etiqueta de texto utilizada junto al ID de la conversación.
- `error_occurred` (string, optional) — Etiqueta de texto utilizada cuando se produce un error.
- `queue_timed_out` (string, optional) — Mensaje de error que se muestra cuando se agota el tiempo de espera en la cola.
- `copy_id` (string, optional) — Texto y etiqueta ARIA utilizados para el botón de copiar ID.
- `initiate_feedback` (string, optional) — Texto que se muestra para pedir comentarios al usuario.
- `request_follow_up_feedback` (string, optional) — Texto que se muestra para solicitar detalles adicionales de los comentarios.
- `thanks_for_feedback` (string, optional) — Texto que se muestra para agradecer al usuario sus comentarios.
- `thanks_for_feedback_details` (string, optional) — Texto adicional que se muestra para explicar el valor de los comentarios de usuarios.
- `follow_up_feedback_placeholder` (string, optional) — Texto de marcador de posición para el campo de introducción de comentarios de seguimiento.
- `submit` (string, optional) — Texto y etiqueta ARIA del botón para enviar.
- `go_back` (string, optional) — Texto y etiqueta ARIA del botón para volver.
- `send_message` (string, optional) — Texto y etiqueta ARIA del botón para enviar un mensaje.
- `text_mode` (string, optional) — Texto y etiqueta ARIA del botón para cambiar al modo de texto.
- `voice_mode` (string, optional) — Texto y etiqueta ARIA del botón para cambiar al modo de voz.
- `switched_to_text_mode` (string, optional) — Notificación emergente que se muestra al cambiar al modo de texto.
- `switched_to_voice_mode` (string, optional) — Notificación emergente que se muestra al cambiar al modo de voz.
- `copy` (string, optional) — Texto y etiqueta ARIA del botón para copiar.
- `download` (string, optional) — Texto y etiqueta ARIA del botón para descargar.
- `wrap` (string, optional) — Texto y etiqueta ARIA del botón para activar o desactivar el ajuste de línea.
- `agent_working` (string, optional) — Texto de estado que se muestra cuando el agente está procesando una llamada a una herramienta.
- `agent_done` (string, optional) — Texto de estado que se muestra cuando el agente termina de procesar una llamada a una herramienta.
- `agent_error` (string, optional) — Texto de estado que se muestra cuando el agente encuentra un error durante una llamada a una herramienta.
- `attach_file` (string, optional) — Texto y etiqueta ARIA del botón para adjuntar un archivo.
- `remove_file` (string, optional) — Etiqueta ARIA del botón para eliminar el archivo.
- `file_upload_error` (string, optional) — Mensaje de error que se muestra cuando no se puede subir un archivo.
- `file_type_unsupported` (string, optional) — Mensaje de error que se muestra cuando se selecciona un tipo de archivo no compatible. Va seguido de la lista de tipos aceptados.
- `file_too_large` (string, optional) — Mensaje de error que se muestra cuando un archivo supera el límite máximo de tamaño.
- `file_limit_reached` (string, optional) — Mensaje de error que se muestra cuando se alcanza el número máximo de archivos para una conversación.
- `typing_indicator` (string, optional) — Texto de estado que se muestra mientras el agente está escribiendo.
- `rich_content_unavailable` (string, optional) — Mensaje alternativo que se muestra cuando no se puede renderizar contenido enriquecido.

### WidgetStyles

- `base` (string, optional) — El color de fondo base.
- `base_hover` (string, optional) — El color del fondo base al pasar el cursor.
- `base_active` (string, optional) — El color del fondo base cuando está activo (al hacer clic).
- `base_border` (string, optional) — El color del borde sobre el fondo base.
- `base_subtle` (string, optional) — El color del texto secundario sobre el fondo base.
- `base_primary` (string, optional) — El color del texto principal sobre el fondo base.
- `base_error` (string, optional) — El color del texto de error sobre el fondo base.
- `accent` (string, optional) — El color de fondo de acento.
- `accent_hover` (string, optional) — El color del fondo de acento al pasar el cursor.
- `accent_active` (string, optional) — El color del fondo de acento cuando está activo (al hacer clic).
- `accent_border` (string, optional) — El color del borde sobre el fondo de acento.
- `accent_subtle` (string, optional) — El color del texto secundario sobre el fondo de acento.
- `accent_primary` (string, optional) — El color del texto principal sobre el fondo de acento.
- `overlay_padding` (double, optional) — El relleno alrededor de los bordes de la ventana gráfica.
- `button_radius` (double, optional) — El radio de los botones.
- `input_radius` (double, optional) — El radio de los campos de entrada.
- `bubble_radius` (double, optional) — El radio de las burbujas de chat.
- `sheet_radius` (double, optional) — El radio predeterminado de las hojas.
- `compact_sheet_radius` (double, optional) — El radio del panel en modo compacto.
- `dropdown_sheet_radius` (double, optional) — El radio del panel desplegable.

### WidgetLanguagePresetResponse

- `first_message` (string, optional)
- `text_contents` (WidgetTextContents, optional) — El contenido de texto del idioma seleccionado.
- `terms_text` (string, optional) — El texto que se mostrará para los términos y condiciones en este idioma
- `terms_html` (string, optional) — El HTML que se mostrará para los términos y condiciones en este idioma
- `terms_key` (string, optional) — La clave que se debe mostrar para los términos y condiciones en este idioma

### FileInputConfig

- `enabled` (boolean, optional, default: true) — Cuando está habilitado, usuarios pueden adjuntar imágenes, PDF o archivos de texto en el chat cuando el LLM admite entrada multimodal.
- `max_files_in_memory` (integer, optional, default: 10) — Número de archivos más recientes que se conservan en memoria durante una conversación. Los archivos más antiguos se resumen y se libera su memoria.
- `max_files_per_conversation` (integer, optional, default: 10) — Total de archivos que un usuario puede subir en una conversación. Las subidas se facturan por archivo. Usa -1 para no establecer límite o un valor >= max_files_in_memory.

### ValidationErrorLocItem

## Examples

**Response**

```json
{
  "agent_id": "agent_id",
  "widget_config": {
    "language": "en",
    "variant": "tiny",
    "placement": "top-left",
    "expandable": "never",
    "avatar": {
      "type": "orb",
      "color_1": "#2792dc",
      "color_2": "#9ce6e6"
    },
    "feedback_mode": "none",
    "end_feedback": {
      "type": "rating"
    },
    "bg_color": "bg_color",
    "text_color": "text_color",
    "btn_color": "btn_color",
    "btn_text_color": "btn_text_color",
    "border_color": "border_color",
    "focus_color": "focus_color",
    "border_radius": 1,
    "btn_radius": 1,
    "action_text": "action_text",
    "start_call_text": "start_call_text",
    "end_call_text": "end_call_text",
    "expand_text": "expand_text",
    "listening_text": "listening_text",
    "speaking_text": "speaking_text",
    "shareable_page_text": "shareable_page_text",
    "shareable_page_show_terms": true,
    "terms_text": "terms_text",
    "terms_html": "terms_html",
    "terms_key": "terms_key",
    "show_avatar_when_collapsed": true,
    "disable_banner": true,
    "override_link": "override_link",
    "markdown_link_allowed_hosts": [
      {
        "hostname": "hostname"
      }
    ],
    "markdown_link_include_www": true,
    "markdown_link_allow_http": true,
    "mic_muting_enabled": true,
    "transcript_enabled": true,
    "text_input_enabled": true,
    "conversation_mode_toggle_enabled": true,
    "default_expanded": true,
    "always_expanded": true,
    "dismissible": true,
    "show_agent_status": true,
    "show_conversation_id": true,
    "strip_audio_tags": true,
    "syntax_highlight_theme": "light",
    "text_contents": {
      "main_label": "main_label",
      "start_call": "start_call",
      "start_chat": "start_chat",
      "new_call": "new_call",
      "end_call": "end_call",
      "mute_microphone": "mute_microphone",
      "change_language": "change_language",
      "collapse": "collapse",
      "expand": "expand",
      "copied": "copied",
      "accept_terms": "accept_terms",
      "dismiss_terms": "dismiss_terms",
      "listening_status": "listening_status",
      "speaking_status": "speaking_status",
      "connecting_status": "connecting_status",
      "chatting_status": "chatting_status",
      "queue_waiting_status": "queue_waiting_status",
      "queue_waiting_status_short": "queue_waiting_status_short",
      "input_label": "input_label",
      "input_placeholder": "input_placeholder",
      "input_placeholder_text_only": "input_placeholder_text_only",
      "input_placeholder_new_conversation": "input_placeholder_new_conversation",
      "user_ended_conversation": "user_ended_conversation",
      "agent_ended_conversation": "agent_ended_conversation",
      "conversation_id": "conversation_id",
      "error_occurred": "error_occurred",
      "queue_timed_out": "queue_timed_out",
      "copy_id": "copy_id",
      "initiate_feedback": "initiate_feedback",
      "request_follow_up_feedback": "request_follow_up_feedback",
      "thanks_for_feedback": "thanks_for_feedback",
      "thanks_for_feedback_details": "thanks_for_feedback_details",
      "follow_up_feedback_placeholder": "follow_up_feedback_placeholder",
      "submit": "submit",
      "go_back": "go_back",
      "send_message": "send_message",
      "text_mode": "text_mode",
      "voice_mode": "voice_mode",
      "switched_to_text_mode": "switched_to_text_mode",
      "switched_to_voice_mode": "switched_to_voice_mode",
      "copy": "copy",
      "download": "download",
      "wrap": "wrap",
      "agent_working": "agent_working",
      "agent_done": "agent_done",
      "agent_error": "agent_error",
      "attach_file": "attach_file",
      "remove_file": "remove_file",
      "file_upload_error": "file_upload_error",
      "file_type_unsupported": "file_type_unsupported",
      "file_too_large": "file_too_large",
      "file_limit_reached": "file_limit_reached",
      "typing_indicator": "typing_indicator",
      "rich_content_unavailable": "rich_content_unavailable"
    },
    "styles": {
      "base": "base",
      "base_hover": "base_hover",
      "base_active": "base_active",
      "base_border": "base_border",
      "base_subtle": "base_subtle",
      "base_primary": "base_primary",
      "base_error": "base_error",
      "accent": "accent",
      "accent_hover": "accent_hover",
      "accent_active": "accent_active",
      "accent_border": "accent_border",
      "accent_subtle": "accent_subtle",
      "accent_primary": "accent_primary",
      "overlay_padding": 1.1,
      "button_radius": 1.1,
      "input_radius": 1.1,
      "bubble_radius": 1.1,
      "sheet_radius": 1.1,
      "compact_sheet_radius": 1.1,
      "dropdown_sheet_radius": 1.1
    },
    "show_resize_button": true,
    "end_confirmation_enabled": true,
    "supported_language_overrides": [
      "es",
      "fr"
    ],
    "language_presets": {
      "key": {}
    },
    "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"

querystring = {"conversation_signature":"conversation_signature"}

response = requests.get(url, params=querystring)

print(response.json())
```

```javascript
const url = 'https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget?conversation_signature=conversation_signature';
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?conversation_signature=conversation_signature"

	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?conversation_signature=conversation_signature")

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?conversation_signature=conversation_signature")
  .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?conversation_signature=conversation_signature');

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.elevenlabs.io/v1/convai/agents/agent_3701k3ttaq12ewp8b7qv5rfyszkz/widget?conversation_signature=conversation_signature");
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?conversation_signature=conversation_signature")! 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()
```