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

# Obter configuração do widget do agente

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

Recupere a configuração do widget de um 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) — O ID de um agente. Ele é retornado na criação do agente.

### Query parameters

- `conversation_signature` (string, optional, nullable) — Um token temporário que permite iniciar uma conversa por websocket. Eles podem ser gerados para um agente usando o endpoint /v1/convai/conversation/get_signed_url

## Response

### 200

Resposta bem-sucedida

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

## Errors

### 422 Unprocessable Entity Error

Erro de validação

- `detail` (list of ValidationError, optional)

## Types

### WidgetConfigResponseModel

- `language` (string, required)
- `variant` (enum, optional, default: full) — A variante do widget
  - Allowed values: `tiny`, `compact`, `full`, `expandable`
- `placement` (enum, optional, default: bottom-right) — O posicionamento do widget na tela
  - Allowed values: `top-left`, `top`, `top-right`, `bottom-left`, `bottom`, `bottom-right`
- `expandable` (enum, optional, default: never) — Indica se o widget pode ser expandido
  - Allowed values: `never`, `mobile`, `desktop`, `always`
- `avatar` (WidgetConfigResponseModelAvatar, optional) — O avatar do widget
- `feedback_mode` (enum, optional, default: none) — O modo de feedback do widget
  - Allowed values: `none`, `during`, `end`
- `end_feedback` (WidgetEndFeedbackConfig, optional, nullable) — Configuração para feedback coletado ao final da conversa
- `bg_color` (string, optional, default: #ffffff) — A cor de fundo do widget
- `text_color` (string, optional, default: #000000) — A cor do texto do widget
- `btn_color` (string, optional, default: #000000) — A cor do botão do widget
- `btn_text_color` (string, optional, default: #ffffff) — A cor do texto do botão do widget
- `border_color` (string, optional, default: #e1e1e1) — A cor da borda do widget
- `focus_color` (string, optional, default: #000000) — A cor de foco do widget
- `border_radius` (integer, optional, nullable) — O raio da borda do widget
- `btn_radius` (integer, optional, nullable) — O raio do botão do widget
- `action_text` (string, optional, nullable) — O texto de ação do widget
- `start_call_text` (string, optional, nullable) — O texto de início da chamada do widget
- `end_call_text` (string, optional, nullable) — O texto de encerramento da chamada do widget
- `expand_text` (string, optional, nullable) — O texto de expansão do widget
- `listening_text` (string, optional, nullable) — O texto a ser exibido quando o agente estiver ouvindo
- `speaking_text` (string, optional, nullable) — O texto a ser exibido quando o agente estiver falando
- `shareable_page_text` (string, optional, nullable) — O texto a ser exibido ao compartilhar
- `shareable_page_show_terms` (boolean, optional, default: true) — Se deve mostrar os termos e condições na página compartilhável
- `terms_text` (string, optional, nullable) — O texto a ser exibido nos termos e condições
- `terms_html` (string, optional, nullable) — O HTML a exibir para os termos e condições
- `terms_key` (string, optional, nullable) — A chave a ser exibida para os termos e condições
- `show_avatar_when_collapsed` (boolean, optional, nullable, default: false) — Se deve mostrar o avatar quando o widget estiver recolhido
- `disable_banner` (boolean, optional, default: false) — Indica se deve desativar o banner
- `override_link` (string, optional, nullable) — O link de substituição para o widget
- `markdown_link_allowed_hosts` (list of AllowlistItem, optional) — Lista de nomes de host permitidos para links clicáveis em Markdown. Use \{ hostname: '\*' } para permitir qualquer domínio. Vazio significa que nenhum link é permitido.
- `markdown_link_include_www` (boolean, optional, default: true) — Indica se deve incluir automaticamente variantes com www. dos hosts permitidos
- `markdown_link_allow_http` (boolean, optional, default: true) — Indica se deve permitir http:// além de https:// para hosts permitidos
- `mic_muting_enabled` (boolean, optional, default: true) — Indica se deve ativar o silenciamento do microfone
- `transcript_enabled` (boolean, optional, default: true) — Indica se o widget deve mostrar a transcrição da conversa à medida que ela ocorre
- `text_input_enabled` (boolean, optional, default: true) — Indica se o usuário deve poder enviar mensagens de texto
- `conversation_mode_toggle_enabled` (boolean, optional, default: false) — Indica se deve ativar o controle de alternância do modo de conversa no widget
- `default_expanded` (boolean, optional, default: false) — Indica se o widget deve ser expandido por padrão
- `always_expanded` (boolean, optional, default: false) — Indica se o widget deve permanecer sempre expandido
- `dismissible` (boolean, optional, default: false) — Indica se o usuário pode fechar o widget
- `show_agent_status` (boolean, optional, default: false) — Se deve mostrar o status de trabalhando/concluído/erro do agente durante o uso da ferramenta
- `show_conversation_id` (boolean, optional, default: true) — Se deve mostrar o ID da conversa após a desconexão.
- `strip_audio_tags` (boolean, optional, default: true) — Se deve remover a marcação de áudio das mensagens.
- `syntax_highlight_theme` (enum, optional, nullable) — Tema para destaque de sintaxe em blocos de código. Por padrão, o widget detecta automaticamente quando não é definido.
  - Allowed values: `light`, `dark`
- `text_contents` (WidgetTextContents, optional) — Conteúdo de texto do widget
- `styles` (WidgetStyles, optional) — Estilos do widget
- `show_resize_button` (boolean, optional, default: true) — Se deve mostrar o botão de redimensionamento
- `end_confirmation_enabled` (boolean, optional, default: false) — Se deve pedir ao usuário que confirme antes de encerrar um chat ou uma chamada
- `supported_language_overrides` (list of string, optional, nullable)
- `language_presets` (map from string to WidgetLanguagePresetResponse, optional) — Predefinições de idioma para o widget
- `text_only` (boolean, optional, default: false) — Se o agente usa o modo somente texto.
- `supports_text_only` (boolean, optional, default: false) — Se o agente pode ser alternado para o modo somente texto.
- `first_message` (string, optional, nullable)
- `use_rtc` (boolean, optional, nullable) — Se deve usar WebRTC para conexões de conversa
- `file_input_config` (FileInputConfig, optional) — Configuração para upload de arquivos no widget

### ValidationError

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

### WidgetConfigResponseModelAvatar

O avatar do widget

### WidgetEndFeedbackConfig

- `type` (enum, optional, default: rating) — O tipo de feedback a ser coletado ao final da conversa
  - Allowed values: `rating`

### AllowlistItem

- `hostname` (string, required) — O nome do host da origem permitida

### WidgetTextContents

- `main_label` (string, optional, nullable) — Chamada para ação exibida nas variantes compacta e completa.
- `start_call` (string, optional, nullable) — Texto e rótulo ARIA do botão de iniciar chamada.
- `start_chat` (string, optional, nullable) — Texto e rótulo ARIA do botão de iniciar chat (somente texto)
- `new_call` (string, optional, nullable) — Texto e rótulo ARIA do botão de nova chamada. Exibido quando a pessoa que liga já concluiu pelo menos uma chamada para iniciar a próxima.
- `end_call` (string, optional, nullable) — Texto e rótulo ARIA do botão de encerrar chamada.
- `mute_microphone` (string, optional, nullable) — Rótulo ARIA do botão de silenciar o microfone.
- `change_language` (string, optional, nullable) — Rótulo ARIA do menu suspenso de alteração de idioma.
- `collapse` (string, optional, nullable) — Rótulo ARIA do botão de recolher.
- `expand` (string, optional, nullable) — Rótulo ARIA do botão de expandir.
- `copied` (string, optional, nullable) — Texto exibido quando o usuário copia um valor usando o botão de copiar.
- `accept_terms` (string, optional, nullable) — Texto e rótulo ARIA do botão de aceitar os termos.
- `dismiss_terms` (string, optional, nullable) — Texto e rótulo ARIA do botão de cancelar os termos.
- `listening_status` (string, optional, nullable) — Status exibido quando o agente está ouvindo.
- `speaking_status` (string, optional, nullable) — Status exibido quando o agente está falando.
- `connecting_status` (string, optional, nullable) — Status exibido quando o agente está se conectando.
- `chatting_status` (string, optional, nullable) — Status exibido quando o agente está conversando por chat (somente texto)
- `queue_waiting_status` (string, optional, nullable) — Status exibido enquanto aguarda na fila por um agente disponível.
- `queue_waiting_status_short` (string, optional, nullable) — Status curto exibido enquanto aguarda um agente disponível.
- `input_label` (string, optional, nullable) — Rótulo ARIA da entrada de mensagem de texto.
- `input_placeholder` (string, optional, nullable) — Texto de placeholder para a entrada de mensagem de texto.
- `input_placeholder_text_only` (string, optional, nullable) — Texto de placeholder para a entrada de mensagem de texto (somente texto)
- `input_placeholder_new_conversation` (string, optional, nullable) — Texto de placeholder para a entrada de mensagem de texto ao iniciar uma nova conversa (somente texto)
- `user_ended_conversation` (string, optional, nullable) — Mensagem informativa exibida quando o usuário encerra a conversa.
- `agent_ended_conversation` (string, optional, nullable) — Mensagem informativa exibida quando o agente encerra a conversa.
- `conversation_id` (string, optional, nullable) — Rótulo de texto usado ao lado do ID da conversa.
- `error_occurred` (string, optional, nullable) — Rótulo de texto usado quando ocorre um erro.
- `queue_timed_out` (string, optional, nullable) — Mensagem de erro exibida quando o tempo de espera na fila se esgota.
- `copy_id` (string, optional, nullable) — Texto e rótulo ARIA usados no botão de copiar ID.
- `initiate_feedback` (string, optional, nullable) — Texto exibido para solicitar feedback ao usuário.
- `request_follow_up_feedback` (string, optional, nullable) — Texto exibido para solicitar detalhes adicionais do feedback.
- `thanks_for_feedback` (string, optional, nullable) — Texto exibido para agradecer ao usuário por fornecer feedback.
- `thanks_for_feedback_details` (string, optional, nullable) — Texto adicional exibido que explica o valor do feedback do usuário.
- `follow_up_feedback_placeholder` (string, optional, nullable) — Texto de placeholder para o campo de entrada de feedback complementar.
- `submit` (string, optional, nullable) — Texto e rótulo ARIA do botão de enviar.
- `go_back` (string, optional, nullable) — Texto e rótulo ARIA do botão de voltar.
- `send_message` (string, optional, nullable) — Texto e rótulo ARIA do botão de enviar mensagem.
- `text_mode` (string, optional, nullable) — Texto e rótulo ARIA do botão de alternar para o modo texto.
- `voice_mode` (string, optional, nullable) — Texto e rótulo ARIA do botão de alternar para o modo voz.
- `switched_to_text_mode` (string, optional, nullable) — Notificação toast exibida ao alternar para o modo de texto.
- `switched_to_voice_mode` (string, optional, nullable) — Notificação toast exibida ao alternar para o modo de voz.
- `copy` (string, optional, nullable) — Texto e rótulo ARIA do botão de copiar.
- `download` (string, optional, nullable) — Texto e rótulo ARIA do botão de download.
- `wrap` (string, optional, nullable) — Texto e rótulo ARIA do botão de alternar quebra de linha.
- `agent_working` (string, optional, nullable) — Texto de status exibido enquanto o agente processa uma chamada de ferramenta.
- `agent_done` (string, optional, nullable) — Texto de status exibido quando o agente termina de processar uma chamada de ferramenta.
- `agent_error` (string, optional, nullable) — Texto de status exibido quando o agente encontra um erro durante uma chamada de ferramenta.
- `attach_file` (string, optional, nullable) — Texto e rótulo ARIA do botão de anexar arquivo.
- `remove_file` (string, optional, nullable) — Rótulo ARIA do botão de remover arquivo.
- `file_upload_error` (string, optional, nullable) — Mensagem de erro exibida quando o upload de um arquivo falha.
- `file_type_unsupported` (string, optional, nullable) — Mensagem de erro exibida quando um tipo de arquivo não compatível é selecionado. Seguida da lista de tipos aceitos.
- `file_too_large` (string, optional, nullable) — Mensagem de erro exibida quando um arquivo excede o limite máximo de tamanho.
- `file_limit_reached` (string, optional, nullable) — Mensagem de erro exibida quando o número máximo de arquivos para uma conversa é atingido.
- `typing_indicator` (string, optional, nullable) — Texto de status exibido enquanto o agente está digitando.
- `rich_content_unavailable` (string, optional, nullable) — Mensagem alternativa exibida quando o conteúdo avançado não pode ser renderizado.

### WidgetStyles

- `base` (string, optional, nullable) — A cor de fundo base.
- `base_hover` (string, optional, nullable) — A cor do plano de fundo base ao passar o cursor.
- `base_active` (string, optional, nullable) — A cor do plano de fundo base quando ativo (clicado).
- `base_border` (string, optional, nullable) — A cor da borda sobre o plano de fundo base.
- `base_subtle` (string, optional, nullable) — A cor do texto secundário sobre o plano de fundo base.
- `base_primary` (string, optional, nullable) — A cor do texto principal sobre o plano de fundo base.
- `base_error` (string, optional, nullable) — A cor do texto de erro sobre o plano de fundo base.
- `accent` (string, optional, nullable) — A cor de fundo de destaque.
- `accent_hover` (string, optional, nullable) — A cor do plano de fundo de destaque ao passar o cursor.
- `accent_active` (string, optional, nullable) — A cor do plano de fundo de destaque quando ativo (clicado).
- `accent_border` (string, optional, nullable) — A cor da borda sobre o plano de fundo de destaque.
- `accent_subtle` (string, optional, nullable) — A cor do texto secundário sobre o plano de fundo de destaque.
- `accent_primary` (string, optional, nullable) — A cor do texto principal sobre o plano de fundo de destaque.
- `overlay_padding` (double, optional, nullable) — O espaçamento interno nas bordas da área de visualização.
- `button_radius` (double, optional, nullable) — O raio dos botões.
- `input_radius` (double, optional, nullable) — O raio dos campos de entrada.
- `bubble_radius` (double, optional, nullable) — O raio dos balões de chat.
- `sheet_radius` (double, optional, nullable) — O raio padrão das folhas.
- `compact_sheet_radius` (double, optional, nullable) — O raio do painel no modo compacto.
- `dropdown_sheet_radius` (double, optional, nullable) — O raio do painel suspenso.

### WidgetLanguagePresetResponse

- `first_message` (string, optional, nullable)
- `text_contents` (WidgetTextContents, optional, nullable) — O conteúdo de texto para o idioma selecionado
- `terms_text` (string, optional, nullable) — O texto a ser exibido nos termos e condições neste idioma
- `terms_html` (string, optional, nullable) — O HTML a exibir para os termos e condições neste idioma
- `terms_key` (string, optional, nullable) — A chave a ser exibida para os termos e condições neste idioma

### FileInputConfig

- `enabled` (boolean, optional, default: true) — Quando ativado, os usuários podem anexar imagens, PDFs ou arquivos de texto no chat quando o LLM oferece suporte a entrada multimodal.
- `max_files_in_memory` (integer, optional, default: 10) — Número dos arquivos mais recentes mantidos na memória durante uma conversa. Os arquivos mais antigos são resumidos e seus bytes são liberados.
- `max_files_per_conversation` (integer, optional, default: 10) — Total de arquivos que um usuário pode enviar em uma conversa. Os envios são cobrados por arquivo. Use -1 para não definir limite ou um valor >= max_files_in_memory.

### ValidationErrorLocItems

### OrbAvatar

- `type` ("orb", optional, default: orb) — O tipo de avatar
- `color_1` (string, optional, default: #2792dc) — A primeira cor do avatar
- `color_2` (string, optional, default: #9ce6e6) — A segunda cor do avatar

### URLAvatar

- `type` ("url", optional, default: url) — O tipo de avatar
- `custom_url` (string, optional, default: ) — A URL personalizada do avatar

### ImageAvatar

- `type` ("image", optional, default: image) — O tipo de avatar
- `url` (string, optional, default: ) — A URL do 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()
```