> ## Documentation Index > Fetch the complete documentation index at: https://docs.mka1.com/llms.txt > Use this file to discover all available pages before exploring further. # Gerar token de sala LiveKit > Gera um token de acesso LiveKit para entrar em uma sala de voz em tempo real. O token inclui credenciais criptografadas e configuração de modelo para o agente de voz. ## OpenAPI ````yaml https://apigw.mka1.com/speakeasy.json?language=pt-BR post /api/v1/llm/speech/livekit/token openapi: 3.1.1 info: title: MKA1 API version: 1.1.0 description: >- A API MKA1 é uma API RESTful que fornece acesso à plataforma MKA1. Aprenda como começar a usar a API e o SDK TypeScript [aqui](https://mka1.apidocumentation.com/guides/getting-started). license: name: Proprietário servers: - url: https://apigw.mka1.com description: MKA1 API Gateway - url: / description: Relative server URL (configurable via SDK constructor) security: [] tags: - name: Resource Authorization description: >- Gerencie permissões para recursos LLM. Crie recursos, conceda/revoque permissões e exclua recursos. Apenas os proprietários dos recursos podem conceder, revogar ou excluir permissões. x-displayName: Autorização de Recurso - name: Embeddings description: >- Endpoints da API de incorporação de texto para gerar representações vetoriais de texto. Crie incorporações semânticas para busca, clustering e correspondência de similaridade usando vários modelos de incorporação. x-displayName: Incorporações - name: Feedback description: >- API de feedback do usuário para avaliar e comentar sobre as conclusões de chat. Coleta de classificações de positivo/negativo e feedback detalhado para melhorar as respostas do modelo e acompanhar a satisfação do usuário. x-displayName: Feedback - name: Images description: >- Pontos de extremidade da API de geração de imagens para criar imagens a partir de descrições de texto. Gere imagens com controle sobre tamanho, qualidade e estilo. x-displayName: Imagens - name: MCP Vault description: >- API do cofre MCP para armazenar configurações de servidor MCP de propriedade do usuário e credenciais criptografadas. Os agentes referenciam IDs de cofre para que os segredos sejam resolvidos apenas no momento da execução da ferramenta. x-displayName: Cofre MCP - name: Speech description: >- Pontos de extremidade da API de fala para processamento de áudio. Converta texto em fala com som natural (TTS) ou transcreva fala em texto (STT) em diferentes idiomas. x-displayName: Discurso - name: Usage description: >- API de rastreamento de uso e análise para monitoramento do consumo de tokens, contagem de solicitações e análise de custos. Veja estatísticas detalhadas por usuário, modelo e período de tempo. x-displayName: Uso - name: Extract description: >- API de extração de dados estruturados para extrair informações de arquivos. Defina esquemas JSON para extrair dados estruturados de imagens, PDFs e documentos. Suporta modelos de esquema reutilizáveis. x-displayName: Extração - name: Text Classification description: >- API de classificação de texto para categorizar textos em rótulos predefinidos. Use modelos de IA para classificar o conteúdo textual para análise de sentimento, categorização de tópicos e moderação de conteúdo. x-displayName: Classificação de Texto - name: Responses description: >- API de respostas com agentes para criar agentes de IA com uso autônomo de ferramentas. Crie assistentes conversacionais que podem usar pesquisa na web, operações de arquivos, geração de imagens, execução de código, simulação de uso de computador e integrações MCP. Suporta processamento em segundo plano, streaming e monitoramento de status em tempo real. x-displayName: Respostas - name: Files description: >- API de gerenciamento de arquivos para upload, armazenamento e gerenciamento de arquivos com expiração automática e integração com S3. Faça upload de arquivos que podem ser usados com Assistentes, Armazenamentos Vetoriais e outras funcionalidades. Os arquivos são armazenados no S3 com metadados rastreados no PostgreSQL. Suporta limpeza automática de arquivos expirados. x-displayName: Arquivos - name: Vector Stores description: >- API de armazenamento de vetores para armazenar e pesquisar documentos usando embeddings. Crie armazenamentos de vetores, faça upload de arquivos com divisão automática e geração de embeddings, e realize pesquisas semânticas. Os arquivos são processados de forma assíncrona usando fluxos de trabalho Temporais para durabilidade. Suporta limpeza automática de armazenamentos expirados e LanceDB para armazenamento eficiente de vetores. x-displayName: Armazenamentos de Vetores - name: Conversations description: >- API de gerenciamento de conversas para armazenar e recuperar o estado da conversa durante chamadas à API de Resposta. Crie conversas, adicione itens (mensagens do usuário, mensagens do assistente, mensagens do sistema) e mantenha o histórico da conversa. Suporta rastreamento de metadados e gerenciamento de estado de diálogo em múltiplas interações. x-displayName: Conversa - name: Guardrails description: >- API de diretrizes de segurança de IA para configurar moderação de conteúdo e políticas de segurança. Configure listas de palavras proibidas, detecção de injeção de prompts e prevenção de vazamento de prompts do sistema. As diretrizes aplicam-se a todas as solicitações de uma conta e podem ser testadas antes da implementação. x-displayName: Guarda-corpos - name: Models description: >- API de listagem de modelos para descobrir modelos disponíveis. Retorna IDs de modelos, propriedade e metadados de todos os modelos registrados no gateway. x-displayName: Modelos - name: Skills description: >- API de habilidades para gerenciar pacotes versionados de instruções e arquivos seguindo o padrão de Habilidades do Agente. Crie, versionar e baixe pacotes de habilidades reutilizáveis que incluam manifestos SKILL.md para ambientes de agentes. x-displayName: Habilidades - name: Chat Completions description: >- **Obsoleto: Use a API de Respostas (`/api/v1/llm/responses`) em vez disso.** Endpoints de conclusão de chat com suporte para streaming, chamadas de ferramentas e múltiplos provedores. x-deprecated: true x-displayName: Conclusões de Bate-Papo - name: Batches x-displayName: Lotes - name: Evals x-displayName: Avaliações - name: Fine-Tuning x-displayName: Ajuste Fino - name: Memory Stores x-displayName: Armazenamentos de Memória - name: Prompts x-displayName: Sugestões - name: API Key x-displayName: Chave da API - name: Organization x-displayName: Organização - name: Cluster Admin x-displayName: Administrador do cluster - name: Sessions description: Crie, inspecione, acesse e encerre sessões de sandbox. x-displayName: Sessões - name: Browser description: >- Conecte-se às sessões do navegador através do proxy da porta do gateway. As sessões do navegador expõem um endpoint do Chrome DevTools Protocol na porta 9222. x-displayName: Navegador - name: Execution description: >- Executar comandos shell e código dentro de uma sessão de sandbox existente. x-displayName: Execução - name: Workspace description: >- Inspecione o manifesto do espaço de trabalho, transfira arquivos ou arquivos compactados e baixe artefatos gerados. x-displayName: Espaço de trabalho - name: Sandbox Usage description: >- Agregue estatísticas de uso da sandbox entre sessões, execução e operações do espaço de trabalho. x-displayName: Uso do Sandbox - name: Sandbox Pricing description: >- Gerenciamento de cluster-admin da tabela de preços de computação da sandbox usada para gastos orçados. x-displayName: Preço da Sandbox - name: Agents description: Crie e gerencie definições de agentes reutilizáveis. x-displayName: Agentes - name: Agent Versions description: >- Inspecione o histórico de configuração de um agente e reverta para uma versão anterior. x-displayName: Versões do Agente - name: Agent Runs description: Execute agentes salvos e inspecione os resultados da execução persistidos. x-displayName: Executa Agente - name: Agent Schedules description: Crie e gerencie execuções de agentes salvos agendadas ou recorrentes. x-displayName: Agendas de Agentes - name: schema-4_other x-displayName: outro - name: Budgets x-displayName: Orçamentos - name: Settings x-displayName: Configurações - name: Deployments description: Servidores de inferência de longa duração. x-displayName: Implantações - name: Fine-Tune Jobs description: Enviar, monitorar e cancelar trabalhos de fine-tuning. x-displayName: Trabalhos de Ajuste Fino - name: Container Images description: Imagens de contêiner personalizadas para implantações e jobs. x-displayName: Imagens de contêineres - name: Serving Models description: Modelos registrados para implantação e ajuste fino. x-displayName: Servindo Modelos - name: Volumes description: Armazenamento persistente para pesos e checkpoints. x-displayName: Volumes - name: Secrets description: Credenciais injetadas em seus workloads. x-displayName: Segredos - name: Accelerators description: Tipos de aceleradores disponíveis (GPU, NPU, TPU). x-displayName: Aceleradores paths: /api/v1/llm/speech/livekit/token: post: tags: - Speech summary: Gerar token de sala LiveKit description: >- Gera um token de acesso LiveKit para entrar em uma sala de voz em tempo real. O token inclui credenciais criptografadas e configuração de modelo para o agente de voz. operationId: livekitToken parameters: - name: X-On-Behalf-Of in: header required: false schema: type: string description: Optional external end-user identifier forwarded by the API gateway. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LivekitTokenRequest' example: llm: model: auto responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/LivekitTokenResponse' example: token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... url: wss://apigw.mka1.com/api/v1/livekit roomName: 550e8400-e29b-41d4-a716-446655440000 security: - bearerAuth: [] x-codeSamples: - lang: python label: Python (SDK) source: |- from meetkai_mka1 import SDK with SDK( bearer_auth="", ) as sdk: res = sdk.llm.speech.livekit_token(llm={ "model": "auto", }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { SDK } from "@meetkai/mka1"; const sdk = new SDK({ bearerAuth: "", }); async function run() { const result = await sdk.llm.speech.livekitToken({ livekitTokenRequest: { llm: { model: "auto", }, }, }); console.log(result); } run(); - lang: csharp label: CSharp (SDK) source: >- using MeetKai.MKA1; using MeetKai.MKA1.Types.Components; var sdk = new SDK(bearerAuth: ""); var res = await sdk.Llm.Speech.LivekitTokenAsync(body: new MeetKai.MKA1.Types.Components.LivekitTokenRequest() { Llm = new MeetKai.MKA1.Types.Components.Llm() { Model = "auto", }, }); // handle response components: schemas: LivekitTokenRequest: type: object properties: llm: type: object properties: model: type: string description: A ID do modelo a ser usada para gerar a resposta. instructions: type: string description: >- Instruções do sistema ou do desenvolvedor inseridas no contexto do modelo antes da entrada do usuário. Use isso para guiar o comportamento do agente, definir personalidade, estabelecer restrições ou fornecer conhecimento específico de domínio. Atua como uma mensagem do sistema persistente para esta resposta. conversation: anyOf: - anyOf: - type: string - $ref: '#/components/schemas/Conversation' - type: 'null' description: >- A conversa à qual esta resposta pertence. Pode ser uma string de ID de conversa ou um objeto de conversa. Usado para manter o contexto e o histórico em várias interações com agentes. Opcional - omita para interações pontuais. previous_response_id: type: string description: >- O ID único de uma resposta anterior para continuar. Usado para conversas de múltiplas turnos para manter o contexto e o histórico. O agente terá acesso a todas as interações anteriores na cadeia. prompt: $ref: '#/components/schemas/PromptTemplate' description: >- Referência a um modelo de prompt a ser usado para esta resposta, junto com variáveis para substituir. Permite usar modelos de prompt predefinidos e versionados em vez de instruções inline. O sistema de modelos suporta interpolação de variáveis. tools: type: array items: anyOf: - $ref: '#/components/schemas/FunctionToolDefinition' - $ref: '#/components/schemas/FileSearchToolDefinition' - $ref: '#/components/schemas/ComputerUseToolDefinition' - $ref: '#/components/schemas/WebSearchToolDefinition' - $ref: '#/components/schemas/MCPToolDefinition' - $ref: '#/components/schemas/CodeInterpreterToolDefinition' - $ref: '#/components/schemas/ImageGenerationToolDefinition' - $ref: '#/components/schemas/LocalShellToolDefinition' - $ref: '#/components/schemas/ShellToolDefinition' - $ref: '#/components/schemas/CustomToolDefinition' - $ref: '#/components/schemas/WebSearchPreviewToolDefinition' - $ref: '#/components/schemas/HostedToolDefinition' - $ref: '#/components/schemas/SleepToolDefinition' - $ref: '#/components/schemas/HistoryToolDefinition' description: >- Matriz de definições de ferramentas que o agente pode usar durante a geração de respostas. Suporta ferramentas integradas (pesquisa na web, pesquisa de arquivos, interpretador de código, uso do computador, geração de imagens) e ferramentas personalizadas (funções, MCP, shell local). Cada definição de ferramenta especifica seu tipo e configuração. tool_choice: $ref: '#/components/schemas/ToolChoice' description: >- Controla como o agente seleciona quais ferramentas usar. Pode ser 'nenhum' (sem ferramentas), 'automático' (o modelo decide), 'obrigatório' (deve usar ferramentas) ou um objeto de seleção de ferramenta específico. Use isso para forçar ou impedir o uso de ferramentas. parallel_tool_calls: type: boolean default: true description: >- Permitir que o agente execute várias chamadas de ferramentas em paralelo. Quando verdadeiro, o agente pode fazer chamadas de ferramentas simultâneas para eficiência. Quando falso, as ferramentas são chamadas sequencialmente. O padrão é verdadeiro para um melhor desempenho. max_tool_calls: type: integer minimum: 1 maximum: 300 default: 64 description: >- O número total máximo de chamadas de ferramentas que o agente pode fazer durante esta resposta. Útil para controlar o tempo de execução e evitar loops infinitos. Aplica-se a todas as ferramentas integradas, como busca na web, busca de arquivos, interpretador de código, etc. Deve ser um número inteiro positivo entre 1 e 300. O padrão é 64. reasoning: $ref: '#/components/schemas/ReasoningConfiguration' description: >- Opções de configuração para modelos de raciocínio. Controla o nível de esforço de raciocínio (mínimo, baixo, médio, alto) e a verbosidade do resumo (automático, conciso, detalhado). Aplicável apenas a modelos específicos com capacidade de raciocínio. max_output_tokens: type: integer minimum: 1 maximum: 9007199254740991 description: >- O número máximo de tokens que o modelo pode gerar em sua saída. Define um limite superior para controlar custos e o comprimento da resposta. A saída real pode ser mais curta se o modelo terminar naturalmente. Deve ser um número inteiro positivo. temperature: type: number minimum: 0 maximum: 2 description: >- Controla a aleatoriedade na saída do modelo. Valores mais altos (por exemplo, 1,5-2,0) tornam a saída mais aleatória e criativa, enquanto valores mais baixos (por exemplo, 0,0-0,5) a tornam mais focada e determinística. Deve estar entre 0 e 2. top_p: type: number minimum: 0 maximum: 1 description: >- Parâmetro de amostragem de núcleo. O modelo considera apenas os tokens com probabilidade acumulada top_p. Valores mais baixos (por exemplo, 0,1) tornam a saída mais focada, enquanto valores mais altos (por exemplo, 0,9) permitem mais diversidade. Deve estar entre 0 e 1. Alternativa à temperatura. truncation: enum: - auto - disabled type: string default: auto description: >- A estratégia de truncamento para lidar com entradas que excedem a janela de contexto do modelo. 'auto' trunca automaticamente mensagens antigas para se ajustar, 'desabilitado' retorna um erro se o contexto for muito longo. O padrão é 'auto'. presence_penalty: type: number minimum: -2 maximum: 2 description: >- Penaliza novos tokens com base em sua aparição no texto até agora. Valores mais altos aumentam a probabilidade do modelo falar sobre novos tópicos. frequency_penalty: type: number minimum: -2 maximum: 2 description: >- Penaliza novos tokens com base em sua frequência no texto até agora. Valores mais altos diminuem a probabilidade do modelo repetir a mesma linha verbatim. context_management: $ref: '#/components/schemas/ContextManagement' description: >- Estratégias de gerenciamento de contexto a serem aplicadas durante a geração de respostas. Suporta compactação, que resume o histórico de conversas mais antigas quando o contexto ultrapassa um limite de token. service_tier: enum: - auto - default - flex - priority type: string default: auto description: >- Especifica o nível de processamento para atender à solicitação. 'auto' permite que o sistema escolha, 'default' usa o processamento padrão, 'flex' permite agendamento flexível para prioridade inferior, 'priority' fornece processamento mais rápido. O padrão é 'auto'. metadata: type: object propertyNames: type: string maxLength: 64 additionalProperties: type: string maxLength: 512 description: >- Metadados personalizados para anexar a esta resposta como pares de chave-valor. As chaves devem ser strings de até 64 caracteres, e os valores devem ser strings de até 512 caracteres. Máximo de 16 pares. Útil para rastreamento, categorização ou passagem de identificadores personalizados pelo seu sistema. text: $ref: '#/components/schemas/TextConfiguration' description: >- Opções de configuração para a saída de texto do modelo. Inclui formato de resposta (texto, objeto JSON, esquema JSON) e nível de detalhamento (baixo, médio, alto). Use isso para controlar a estrutura da saída e o nível de detalhe. required: - model description: >- Configuração do LLM para a sessão de voz. Utiliza um subconjunto do esquema de criação de respostas — campos como entrada, stream, fundo, webhooks e armazenamento estão excluídos, pois o agente de voz gerencia esses. AVISO: Este objeto é serializado nos metadados JWT do LiveKit, que são transmitidos através de cabeçalhos HTTP. Mantenha as cargas úteis pequenas — grandes arrays de ferramentas podem exceder o limite de tamanho de cabeçalho de ~8KB imposto pela maioria dos servidores e proxies. stt: $ref: '#/components/schemas/SttConfig' description: >- Configuração opcional de VAD (detecção de atividade de voz) para STT (conversão de fala em texto). required: - llm description: >- Parâmetros de solicitação para gerar um token de sala LiveKit com configuração LLM e configurações opcionais de STT. LivekitTokenResponse: type: object properties: token: type: string description: Token de acesso JWT para autenticação com a sala LiveKit url: type: string format: uri description: >- URL do WebSocket do servidor LiveKit para conectar-se (por exemplo, wss://apigw.mka1.com/api/v1/livekit) roomName: type: string description: Nome da sala UUID gerado automaticamente atribuído a esta sessão required: - token - url - roomName description: >- Resposta contendo um token de acesso LiveKit, URL do servidor e o nome da sala gerada. examples: - token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... url: wss://apigw.mka1.com/api/v1/livekit roomName: 550e8400-e29b-41d4-a716-446655440000 Conversation: type: object properties: id: type: string required: - id PromptTemplate: type: object properties: id: type: string variables: type: object propertyNames: type: string additionalProperties: anyOf: - type: string - {} version: type: string required: - id FunctionToolDefinition: type: object properties: type: const: function name: type: string parameters: type: object propertyNames: type: string additionalProperties: {} strict: type: boolean description: type: string defer_loading: type: boolean required: - type - name - parameters - strict title: Function tool definition description: >- Definição da ferramenta de função: Define uma ferramenta de função chamável. Forneça um nome de ferramenta e um esquema de parâmetros, com descrição opcional e carregamento diferido. FileSearchToolDefinition: type: object properties: type: const: file_search vector_store_ids: type: array items: type: string filters: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - $ref: '#/components/schemas/CompoundFilter' max_num_results: type: integer minimum: 1 maximum: 50 ranking_options: $ref: '#/components/schemas/RankingOptions' required: - type - vector_store_ids title: File search tool definition description: >- Definição da ferramenta de busca de arquivos: Configura a busca semântica em um ou mais armazenamentos vetoriais, com filtros opcionais, opções de classificação e limites de resultados. ComputerUseToolDefinition: type: object properties: type: const: computer_use_preview display_height: type: integer minimum: -9007199254740991 maximum: 9007199254740991 display_width: type: integer minimum: -9007199254740991 maximum: 9007199254740991 environment: type: string required: - type - display_height - display_width - environment title: Computer use tool definition description: >- Definição da ferramenta de uso de computador: Configura a ferramenta de prévia de uso do computador, incluindo dimensões de exibição necessárias e ambiente de execução. WebSearchToolDefinition: type: object properties: type: enum: - web_search - web_search_2025_08_26 type: string filters: $ref: '#/components/schemas/WebSearchFilters' search_context_size: enum: - low - medium - high type: string default: medium user_location: $ref: '#/components/schemas/UserLocation' required: - type title: Web search tool definition description: >- Definição da ferramenta de busca na web: Permite busca na web com filtros de domínio opcionais, tamanho do contexto de busca e localização aproximada do usuário. MCPToolDefinition: type: object properties: type: const: mcp server_label: type: string minLength: 1 maxLength: 255 pattern: ^[A-Za-z0-9._-]+$ mcp_server_id: type: string description: >- Referência a um servidor MCP gerenciado por um gateway. Quando fornecido, server_url é resolvido a partir do cofre MCP. mcp_credential_id: type: string description: >- Referência opcional a uma credencial MCP gerenciada por gateway, de propriedade do chamador da execução. allowed_tools: anyOf: - type: array items: type: string - $ref: '#/components/schemas/MCPToolFilter' authorization: type: string connector_id: enum: - connector_dropbox - connector_gmail - connector_googlecalendar - connector_googledrive - connector_microsoftteams - connector_outlookcalendar - connector_outlookemail - connector_sharepoint type: string headers: type: object propertyNames: type: string minLength: 1 maxLength: 256 pattern: ^[!#$%&'*+.^_`|~0-9A-Za-z-]+$ additionalProperties: type: string minLength: 1 maxLength: 8192 pattern: ^[^\r\n]*$ require_approval: anyOf: - const: always - const: never - $ref: '#/components/schemas/MCPToolApprovalFilter' server_description: type: string server_url: type: string required: - type title: MCP tool definition description: >- Definição da ferramenta MCP: Conecta-se a um servidor MCP e expõe suas ferramentas, com referências de cofre opcionais, autenticação, cabeçalhos, listas de permissão, ID do conector e política de aprovação. CodeInterpreterToolDefinition: type: object properties: type: const: code_interpreter container: anyOf: - type: string - $ref: '#/components/schemas/CodeInterpreterContainerAuto' required: - type - container title: Code interpreter tool definition description: >- Definição da ferramenta de interpretador de código: Permite a execução de código. Forneça um ID de contêiner explícito ou configuração automática de contêiner com IDs de arquivos opcionais e limite de memória. ImageGenerationToolDefinition: type: object properties: type: const: image_generation background: enum: - transparent - opaque - auto type: string default: auto input_fidelity: enum: - high - low type: string default: low input_image_mask: $ref: '#/components/schemas/InputImageMask' model: type: string minLength: 1 default: auto description: >- O modelo a ser utilizado para geração de imagem. O padrão é 'auto' para seleção automática de modelo. moderation: enum: - auto - low - none type: string default: auto output_compression: type: integer minimum: -9007199254740991 maximum: 9007199254740991 default: 100 output_format: enum: - png - webp - jpeg type: string default: png partial_images: type: integer minimum: 0 maximum: 3 default: 0 quality: enum: - low - medium - high - auto type: string default: auto size: enum: - 1024x1024 - 1024x1536 - 1536x1024 - auto type: string default: auto prompt_guard: type: string description: >- Adiciona uma proteção para evitar que o modelo gere conteúdo que não é permitido. required: - type title: Image generation tool definition description: >- Definição da ferramenta de geração de imagem: Permite a geração de imagens e configura as configurações de saída, como modelo, qualidade, tamanho, formato, moderação e mascaramento opcional. LocalShellToolDefinition: type: object properties: type: const: local_shell required: - type title: Local shell tool definition description: >- Definição da ferramenta de shell local: Habilita a ferramenta de execução do shell local. ShellToolDefinition: type: object properties: type: const: shell environment: $ref: '#/components/schemas/ShellEnvironment' description: Configuração do ambiente do contêiner. Padrões para container_auto. required: - type title: Shell tool definition description: >- Definição da ferramenta shell: Permite a execução de comandos shell em um ambiente de contêiner gerenciado. CustomToolDefinition: type: object properties: type: const: custom name: type: string description: type: string format: $ref: '#/components/schemas/CustomToolFormat' required: - type - name title: Custom tool definition description: >- Definição de ferramenta personalizada: Define uma ferramenta personalizada pelo nome, com descrição opcional e restrições de formato de saída opcionais. WebSearchPreviewToolDefinition: type: object properties: type: enum: - web_search_preview - web_search_preview_2025_03_11 type: string search_context_size: enum: - low - medium - high type: string user_location: $ref: '#/components/schemas/UserLocation' required: - type title: Web search preview tool definition description: >- Definição da ferramenta de visualização de pesquisa na web: Habilita a variante da ferramenta de visualização de pesquisa na web com tamanho de contexto opcional e localização do usuário. HostedToolDefinition: type: object properties: type: enum: - file_search - web_search_preview - computer_use_preview - code_interpreter - image_generation type: string required: - type title: Hosted tool definition description: >- Definição de ferramenta hospedada: Seletor de ferramenta hospedada abreviado para tipos de ferramentas integradas. Esta é uma forma de compatibilidade que se sobrepõe aos esquemas detalhados por ferramenta. SleepToolDefinition: type: object properties: type: const: sleep required: - type title: Sleep tool definition description: >- Definição da ferramenta de sono: Permite que um agente pause brevemente a resposta atual e retome mais tarde ou quando for despertado. HistoryToolDefinition: type: object properties: type: const: history required: - type title: History tool definition description: >- Definição da ferramenta de histórico: Habilita a ferramenta de recuperação do histórico de conversas internas para pesquisa semântica de interações passadas. ToolChoice: anyOf: - $ref: '#/components/schemas/ToolChoiceMode' - $ref: '#/components/schemas/AllowedTools' - $ref: '#/components/schemas/HostedToolChoice' - $ref: '#/components/schemas/FunctionToolChoice' - $ref: '#/components/schemas/MCPToolChoice' - $ref: '#/components/schemas/CustomToolChoice' ReasoningConfiguration: type: object properties: effort: anyOf: - enum: - none - minimal - low - medium - high - xhigh type: string - type: 'null' summary: anyOf: - enum: - auto - concise - detailed type: string - type: 'null' required: - effort - summary ContextManagement: type: array maxItems: 1 items: $ref: '#/components/schemas/CompactionContextManagement' description: >- Conjunto de estratégias de gerenciamento de contexto a serem aplicadas durante a geração de respostas. TextConfiguration: type: object properties: format: $ref: '#/components/schemas/ResponseFormat' verbosity: enum: - low - medium - high type: string default: medium required: - format SttConfig: type: object properties: silence_timeout_ms: type: integer minimum: 100 maximum: 5000 description: >- Timeout de silêncioso VAD do lado do servidor em ms (100–5000). Controla quanto tempo esperar após o silêncio antes de finalizar a fala. initial_silence_timeout_ms: type: integer minimum: 1000 maximum: 30000 description: >- Tempo limite em ms antes que qualquer fala seja detectada (1000–30000). description: >- Configuração opcional de VAD (detecção de atividade de voz) para a sessão de voz. ComparisonFilter: type: object properties: type: enum: - eq - ne - gt - gte - lt - lte type: string key: type: string value: anyOf: - type: string - type: number - type: boolean required: - type - key - value CompoundFilter: type: object properties: type: enum: - and - or type: string filters: type: array items: anyOf: - $ref: '#/components/schemas/ComparisonFilter' - $ref: '#/components/schemas/CompoundFilter' required: - type - filters RankingOptions: type: object properties: ranker: type: string score_threshold: type: number WebSearchFilters: type: object properties: allowed_domains: type: array items: type: string default: [] UserLocation: type: object properties: type: const: approximate default: approximate city: type: string country: type: string region: type: string timezone: type: string MCPToolFilter: type: object properties: read_only: type: boolean tool_names: type: array items: type: string MCPToolApprovalFilter: type: object properties: always: $ref: '#/components/schemas/MCPToolFilter' never: $ref: '#/components/schemas/MCPToolFilter' CodeInterpreterContainerAuto: type: object properties: type: const: auto file_ids: anyOf: - type: array items: type: string - type: 'null' memory_limit: anyOf: - enum: - 1g - 4g - 16g - 64g type: string - type: 'null' required: - type InputImageMask: type: object properties: file_id: type: string image_url: type: string ShellEnvironment: anyOf: - $ref: '#/components/schemas/ShellEnvironmentContainerAuto' - $ref: '#/components/schemas/ShellEnvironmentContainerReference' discriminator: propertyName: type mapping: container_auto: $ref: '#/components/schemas/ShellEnvironmentContainerAuto' container_reference: $ref: '#/components/schemas/ShellEnvironmentContainerReference' CustomToolFormat: anyOf: - $ref: '#/components/schemas/TextFormat' - $ref: '#/components/schemas/GrammarFormat' ToolChoiceMode: enum: - none - auto - required type: string title: Tool choice mode description: >- Modo de escolha de ferramenta: Seleciona como o modelo decide o uso das ferramentas. Use nenhum, automático ou necessário. AllowedTools: type: object properties: type: const: allowed_tools mode: enum: - auto - required type: string tools: type: array items: type: object properties: type: type: string name: type: string server_label: type: string required: - type required: - type - mode - tools title: Allowed tools tool choice description: >- Ferramentas permitidas na escolha de ferramentas: Restringe o uso de ferramentas a uma lista fornecida e define se o uso da ferramenta é opcional (automático) ou obrigatório (requerido). HostedToolChoice: type: object properties: type: enum: - file_search - web_search_preview - computer_use_preview - code_interpreter - image_generation type: string required: - type title: Hosted tool choice description: >- Escolha de ferramenta hospedada: Força um tipo específico de ferramenta hospedada embutida. FunctionToolChoice: type: object properties: type: const: function name: type: string required: - type - name title: Function tool choice description: >- Escolha de ferramenta de função: Força uma ferramenta de função específica pelo nome. MCPToolChoice: type: object properties: type: const: mcp server_label: type: string name: type: string required: - type - server_label title: MCP tool choice description: >- Escolha da ferramenta MCP: Força um servidor MCP, opcionalmente restrito a um nome específico de ferramenta MCP. CustomToolChoice: type: object properties: type: const: custom name: type: string required: - type - name title: Custom tool choice description: >- Escolha de ferramenta personalizada: Força uma ferramenta personalizada específica pelo nome. CompactionContextManagement: type: object properties: type: const: compaction compact_threshold: type: integer minimum: 1000 maximum: 9007199254740991 description: >- O limite de tokens acima do qual o contexto da conversa deve ser compactado. Deve ser pelo menos 1000. required: - type - compact_threshold ResponseFormat: anyOf: - $ref: '#/components/schemas/TextResponseFormat' - $ref: '#/components/schemas/JSONSchemaResponseFormat' - $ref: '#/components/schemas/JSONObjectResponseFormat' ShellEnvironmentContainerAuto: type: object properties: type: const: container_auto network_policy: $ref: '#/components/schemas/ShellNetworkPolicy' description: Política de rede restringindo o acesso de saída. skills: type: array items: $ref: '#/components/schemas/SkillEntry' description: Habilidades para injetar no diretório /skills do contêiner. memory_stores: type: array items: $ref: '#/components/schemas/MemoryStoreMount' description: Memórias armazenadas para montar no contêiner em /mnt/memory. required: - type ShellEnvironmentContainerReference: type: object properties: type: const: container_reference container_id: type: string description: ID de um contêiner existente para reutilizar. network_policy: $ref: '#/components/schemas/ShellNetworkPolicy' description: Política de rede restringindo o acesso de saída. skills: type: array items: $ref: '#/components/schemas/SkillEntry' description: Habilidades para injetar no diretório /skills do contêiner. memory_stores: type: array items: $ref: '#/components/schemas/MemoryStoreMount' description: Memórias armazenadas para montar no contêiner em /mnt/memory. required: - type - container_id TextFormat: type: object properties: type: const: text required: - type GrammarFormat: type: object properties: type: const: grammar definition: type: string syntax: enum: - lark - regex type: string required: - type - definition - syntax TextResponseFormat: type: object properties: type: const: text required: - type JSONSchemaResponseFormat: type: object properties: type: const: json_schema name: type: string maxLength: 64 pattern: ^[a-zA-Z0-9_-]+$ schema: type: object propertyNames: type: string additionalProperties: {} description: type: string strict: type: boolean default: false required: - type - name - schema JSONObjectResponseFormat: type: object properties: type: const: json_object required: - type ShellNetworkPolicy: type: object properties: type: const: allowlist allowed_domains: type: array items: type: string description: Domínios permitidos para acesso de rede de saída. domain_secrets: type: array items: $ref: '#/components/schemas/ShellNetworkPolicyDomainSecret' description: Segredos injetados por domínio. required: - type SkillEntry: anyOf: - $ref: '#/components/schemas/SkillReference' - $ref: '#/components/schemas/PreconfiguredSkillReference' discriminator: propertyName: type mapping: skill_reference: $ref: '#/components/schemas/SkillReference' preconfigured: $ref: '#/components/schemas/PreconfiguredSkillReference' MemoryStoreMount: type: object properties: store_id: type: string minLength: 1 description: ID do armazenamento de memória a ser montado no contêiner. label: type: string minLength: 1 maxLength: 64 pattern: ^(?!\.+$)[A-Za-z0-9._-]+$ description: Nome do diretório para esta loja em /mnt/memory. access: enum: - read_only - read_write type: string default: read_only description: Se o armazenamento de memória montado pode ser modificado. description: type: string maxLength: 2000 description: Descrição curta opcional da loja para o contexto do agente. instructions: type: string maxLength: 4000 description: >- Instruções opcionais sobre como o agente deve usar esta loja montada. required: - store_id - label ShellNetworkPolicyDomainSecret: type: object properties: domain: type: string description: O domínio para associar este segredo. name: type: string description: O nome/placeholders para o segredo (por exemplo, $API_KEY). value: type: string description: O valor secreto a ser substituído. required: - domain - name - value SkillReference: type: object properties: type: const: skill_reference skill_id: type: string description: ID da habilidade a ser injetada no contêiner. version: anyOf: - type: string - type: integer minimum: -9007199254740991 maximum: 9007199254740991 description: >- Número da versão, ou 'mais recente' para a versão mais recente. Padrão para a versão padrão da habilidade. required: - type - skill_id PreconfiguredSkillReference: type: object properties: type: const: preconfigured name: type: string description: >- Nome de uma habilidade predefinida (por exemplo, 'pdf', 'docx', 'xlsx', 'pptx'). required: - type - name securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: API Key description: >- Gateway auth: send `Authorization: Bearer `. For multi-user server-side integrations, you can also send `X-On-Behalf-Of: `. ````