Gemini API

A API Gemini Interactions é uma API experimental que permite aos desenvolvedores criar aplicativos de IA generativa usando modelos do Gemini. O Gemini é nosso modelo mais avançado, criado desde o início para ser multimodal. Ele pode generalizar, entender, operar e combinar diferentes tipos de informações, incluindo idiomas, imagens, áudio, vídeo e código. Você pode usar a API Gemini para casos de uso como raciocínio em textos e imagens, geração de conteúdo, agentes de diálogo, sistemas de resumo e classificação e muito mais.

Ver como Markdown Ver a especificação OpenAPI

CreateWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks

Cria um webhook.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (obrigatório)

Obrigatório. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (objeto ou string)  (obrigatório)

Obrigatório. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

Resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (opcional)

Obrigatório. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (object or string)  (optional)

Obrigatório. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (opcional)

Apenas saída. O carimbo de data/hora em que o webhook foi criado.

update_time string  (opcional)

Apenas saída. O carimbo de data/hora da última atualização do webhook.

signing_secrets SigningSecret  (opcional)

Apenas saída. Os secrets de assinatura associados a este webhook.

Representa um secret de assinatura usado para verificar payloads de webhook.

Campos

truncated_secret string  (opcional)

Apenas saída. A versão truncada da chave secreta de assinatura.

expire_time string  (opcional)

Apenas saída. A data de validade da chave secreta de assinatura.

state enum (string)  (opcional)

Apenas saída. O estado do webhook.

Valores possíveis:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (opcional)

Apenas saída. O novo secret de assinatura do webhook. Preenchido apenas na criação.

id string  (opcional)

Apenas saída. O ID do webhook.

Exemplo

Exemplo de resposta

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

ListWebhooks

get https://generativelanguage.googleapis.com/v1beta/webhooks

Lista todos os webhooks.

Parâmetros de caminho / consulta

page_size integer  (optional)

Opcional. O número máximo de webhooks a serem retornados. O serviço pode retornar menos que esse valor. Se não for especificado, no máximo 50 webhooks serão retornados. O valor máximo é 1.000.

page_token string  (opcional)

Opcional. Um token de página recebido de uma chamada "ListWebhooks" anterior. Forneça isso para recuperar a página subsequente.

Resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

webhooks array (Webhook)  (opcional)

Os webhooks.

next_page_token string  (opcional)

Um token, que pode ser enviado como "page_token" para recuperar a próxima página. Se esse campo for omitido, não haverá páginas subsequentes.

Exemplo

Exemplo de resposta

{
  "webhooks": [
    {
      "name": "string",
      "uri": "string",
      "subscribed_events": [
        "string"
      ],
      "create_time": "string",
      "update_time": "string",
      "signing_secrets": [
        {
          "truncated_secret": "string",
          "expire_time": "string"
        }
      ],
      "state": "enabled",
      "new_signing_secret": "string",
      "id": "string"
    }
  ],
  "next_page_token": "string"
}

GetWebhook

get https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Recebe um webhook específico.

Parâmetros de caminho / consulta

id string  (obrigatório)

Obrigatório. O ID do webhook a ser recuperado.

Resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (opcional)

Obrigatório. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (object or string)  (optional)

Obrigatório. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (opcional)

Apenas saída. O carimbo de data/hora em que o webhook foi criado.

update_time string  (opcional)

Apenas saída. O carimbo de data/hora da última atualização do webhook.

signing_secrets SigningSecret  (opcional)

Apenas saída. Os secrets de assinatura associados a este webhook.

Representa um secret de assinatura usado para verificar payloads de webhook.

Campos

truncated_secret string  (opcional)

Apenas saída. A versão truncada da chave secreta de assinatura.

expire_time string  (opcional)

Apenas saída. A data de validade da chave secreta de assinatura.

state enum (string)  (opcional)

Apenas saída. O estado do webhook.

Valores possíveis:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (opcional)

Apenas saída. O novo secret de assinatura do webhook. Preenchido apenas na criação.

id string  (opcional)

Apenas saída. O ID do webhook.

Exemplo

Exemplo de resposta

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

UpdateWebhook

patch https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Atualiza um webhook existente.

Parâmetros de caminho / consulta

id string  (obrigatório)

Obrigatório. O ID do webhook a ser atualizado.

update_mask string  (opcional)

Opcional. Lista de campos a serem atualizados.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (opcional)

Opcional. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (object or string)  (optional)

Opcional. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

state enum (string)  (opcional)

Opcional. O estado do webhook.

Valores possíveis:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries

Resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (opcional)

Obrigatório. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (object or string)  (optional)

Obrigatório. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (opcional)

Apenas saída. O carimbo de data/hora em que o webhook foi criado.

update_time string  (opcional)

Apenas saída. O carimbo de data/hora da última atualização do webhook.

signing_secrets SigningSecret  (opcional)

Apenas saída. Os secrets de assinatura associados a este webhook.

Representa um secret de assinatura usado para verificar payloads de webhook.

Campos

truncated_secret string  (opcional)

Apenas saída. A versão truncada da chave secreta de assinatura.

expire_time string  (opcional)

Apenas saída. A data de validade da chave secreta de assinatura.

state enum (string)  (opcional)

Apenas saída. O estado do webhook.

Valores possíveis:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (opcional)

Apenas saída. O novo secret de assinatura do webhook. Preenchido apenas na criação.

id string  (opcional)

Apenas saída. O ID do webhook.

Exemplo

Exemplo de resposta

{
  "name": "string",
  "uri": "string",
  "subscribed_events": [
    "string"
  ],
  "create_time": "string",
  "update_time": "string",
  "signing_secrets": [
    {
      "truncated_secret": "string",
      "expire_time": "string"
    }
  ],
  "state": "enabled",
  "new_signing_secret": "string",
  "id": "string"
}

DeleteWebhook

delete https://generativelanguage.googleapis.com/v1beta/webhooks/{id}

Exclui um webhook.

Parâmetros de caminho / consulta

id string  (obrigatório)

Obrigatório. O ID do webhook a ser excluído. Formato: `{webhook_id}`

Resposta

Se a solicitação for concluída, a resposta estará vazia.

Exemplo

RotateSigningSecret

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:rotateSigningSecret

Gera um novo secret de assinatura para um webhook.

Parâmetros de caminho / consulta

id string  (obrigatório)

Obrigatório. O ID do webhook para o qual um segredo de assinatura será gerado. Formato: `{webhook_id}`

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

revocation_behavior enum (string)  (opcional)

Opcional. O comportamento de revogação para secrets de assinatura anteriores.

Valores possíveis:

  • revoke_previous_secrets_after_h24
  • revoke_previous_secrets_immediately

Resposta

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

secret string  (opcional)

Apenas saída. A nova chave secreta de assinatura gerada.

Exemplo

Exemplo de resposta

{
  "secret": "string"
}

PingWebhook

post https://generativelanguage.googleapis.com/v1beta/webhooks/{id}:ping

Envia um evento de ping para um webhook.

Parâmetros de caminho / consulta

id string  (obrigatório)

Obrigatório. O ID do webhook a ser testado. Formato: `{webhook_id}`

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Resposta

Se a solicitação for concluída, a resposta estará vazia.

Exemplo

Recursos

Webhook

Um recurso de webhook.

Campos

name string  (opcional)

Opcional. O nome do webhook fornecido pelo usuário.

uri string  (opcional)

Obrigatório. O URI para onde os eventos de webhook serão enviados.

subscribed_events array (object or string)  (optional)

Obrigatório. Os eventos a que o webhook está inscrito. Eventos disponíveis: - batch.succeeded - batch.expired - batch.failed - interaction.requires_action - interaction.completed - interaction.failed - video.generated

create_time string  (opcional)

Apenas saída. O carimbo de data/hora em que o webhook foi criado.

update_time string  (opcional)

Apenas saída. O carimbo de data/hora da última atualização do webhook.

signing_secrets SigningSecret  (opcional)

Apenas saída. Os secrets de assinatura associados a este webhook.

Representa um secret de assinatura usado para verificar payloads de webhook.

Campos

truncated_secret string  (opcional)

Apenas saída. A versão truncada da chave secreta de assinatura.

expire_time string  (opcional)

Apenas saída. A data de validade da chave secreta de assinatura.

state enum (string)  (opcional)

Apenas saída. O estado do webhook.

Valores possíveis:

  • enabled
  • disabled
  • disabled_due_to_failed_deliveries
new_signing_secret string  (opcional)

Apenas saída. O novo secret de assinatura do webhook. Preenchido apenas na criação.

id string  (opcional)

Apenas saída. O ID do webhook.

Modelos de dados

InteractionSseEvent

Tipos possíveis

Discriminador polimórfico: event_type

InteractionCreatedEvent

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "interaction.created".

interaction Interaction  (obrigatório)

Nenhuma descrição informada.

O recurso "Interaction".

Campos

model ModelOption  (opcional)

O nome do "Model" usado para gerar a interação.

Valores possíveis:

  • gemini-2.5-computer-use-preview-10-2025

    Um modelo de capacidade de agente projetado para interação direta com a interface, permitindo que o Gemini perceba e navegue em ambientes digitais.

  • gemini-2.5-flash

    Nosso primeiro modelo de raciocínio híbrido, que oferece suporte a uma janela de contexto de 1 milhão de tokens e tem limites de raciocínio.

  • gemini-2.5-flash-image

    Nosso modelo nativo de geração de imagens, otimizado para velocidade, flexibilidade e compreensão contextual. A entrada e a saída de texto têm o mesmo preço do 2.5 Flash.

  • gemini-2.5-flash-lite

    Nosso modelo menor e mais econômico, criado para uso em grande escala.

  • gemini-2.5-flash-lite-preview-09-2025

    O modelo mais recente baseado no Gemini 2.5 Flash lite otimizado para custo-benefício, alta capacidade de processamento e alta qualidade.

  • gemini-2.5-flash-native-audio-preview-12-2025

    Nossos modelos de áudio nativos são otimizados para saídas de áudio de maior qualidade, com melhor ritmo, naturalidade da voz, nível de detalhes e humor.

  • gemini-2.5-flash-preview-09-2025

    O modelo mais recente baseado no modelo 2.5 Flash. O pré-lançamento do 2.5 Flash é ideal para processamento em grande escala, baixa latência, tarefas de alto volume que exigem raciocínio e casos de uso de agentes.

  • gemini-2.5-flash-preview-tts

    Nosso modelo de conversão de texto em voz 2.5 Flash otimizado para geração de fala controlável, potente e de baixa latência.

  • gemini-2.5-pro

    Nosso modelo multifuncional de última geração, que se destaca em programação e tarefas de raciocínio complexas.

  • gemini-2.5-pro-preview-tts

    Nosso modelo de áudio Text-to-Speech 2.5 Pro é otimizado para geração de fala poderosa e de baixa latência, com saídas mais naturais e comandos mais fáceis de direcionar.

  • gemini-3-flash-preview

    Nosso modelo mais inteligente, criado para ser rápido, combinando inteligência de ponta com pesquisa e embasamento superiores.

  • gemini-3-pro-image-preview

    Modelo de edição e geração de imagens de última geração.

  • gemini-3-pro-preview

    Nosso modelo mais inteligente com raciocínio e compreensão multimodal de última geração, além de recursos avançados de programação assistida por IA e vibe coding.

  • gemini-3.1-pro-preview

    Nosso mais recente modelo de raciocínio SOTA com profundidade e nuances sem precedentes, além de recursos avançados de compreensão multimodal e programação.

  • gemini-3.1-flash-image-preview

    Inteligência visual de nível profissional com eficiência de velocidade do Flash e recursos de geração baseados na realidade.

  • gemini-3.1-flash-lite-preview

    Nosso modelo mais econômico, otimizado para tarefas agentivas de alto volume, tradução e processamento de dados simples.

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS: geração de fala eficiente e de baixa latência. Aproveite saídas naturais, comandos direcionáveis e novas tags de áudio expressivas para um controle preciso da narração.

  • lyria-3-clip-preview

    Nosso modelo de geração de música de baixa latência otimizado para clipes de áudio de alta fidelidade e controle rítmico preciso.

  • lyria-3-pro-preview

    Nosso modelo generativo avançado de músicas completas com compreensão composicional profunda, otimizado para controle estrutural preciso e transições complexas em diversos estilos musicais.

O modelo que vai concluir seu comando.\n\nConsulte [modelos](https://ai.google.dev/gemini-api/docs/models) para mais detalhes.

agent AgentOption  (opcional)

O nome do "Agente" usado para gerar a interação.

Valores possíveis:

  • deep-research-pro-preview-12-2025

    Agente Deep Research do Gemini

  • deep-research-preview-04-2026

    Agente Deep Research do Gemini

  • deep-research-max-preview-04-2026

    Agente Deep Research Max do Gemini

O agente com quem interagir.

id string  (opcional)

Obrigatório. Apenas saída. Um identificador exclusivo para a conclusão da interação.

status enum (string)  (opcional)

Obrigatório. Apenas saída. O status da interação.

Valores possíveis:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
created string  (opcional)

Obrigatório. Apenas saída. O horário em que a resposta foi criada no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).

updated string  (opcional)

Obrigatório. Apenas saída. A hora em que a resposta foi atualizada pela última vez no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).

role string  (opcional)

Apenas saída. A função da interação.

system_instruction string  (opcional)

Instrução do sistema para a interação.

ferramentas Ferramenta  (opcional)

Uma lista de declarações de ferramentas que o modelo pode chamar durante a interação.

Uma ferramenta que pode ser usada pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

Função

Uma ferramenta que pode ser usada pelo modelo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function".

name string  (opcional)

O nome da função.

description string  (opcional)

Uma descrição da função.

parameters object  (opcional)

O esquema JSON para os parâmetros da função.

CodeExecution

Uma ferramenta que pode ser usada pelo modelo para executar código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution".

UrlContext

Uma ferramenta que pode ser usada pelo modelo para buscar o contexto do URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context".

ComputerUse

Uma ferramenta que pode ser usada pelo modelo para interagir com o computador.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "computer_use".

environment enum (string)  (opcional)

O ambiente em operação.

Valores possíveis:

  • browser
excluded_predefined_functions array (string)  (opcional)

A lista de funções predefinidas que são excluídas da chamada de modelo.

McpServer

Um MCPServer é um servidor que pode ser chamado pelo modelo para realizar ações.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server".

name string  (opcional)

O nome do MCPServer.

url string  (opcional)

O URL completo do endpoint MCPServer. Exemplo: "https://api.example.com/mcp"

headers object  (opcional)

Opcional: campos para cabeçalhos de autenticação, tempos limite etc., se necessário.

allowed_tools AllowedTools  (opcional)

As ferramentas permitidas.

A configuração para ferramentas permitidas.

Campos

mode ToolChoiceType  (opcional)

O modo da escolha de ferramenta.

Valores possíveis:

  • auto
  • any
  • none
  • validated

tools array (string)  (opcional)

Os nomes das ferramentas permitidas.

GoogleSearch

Uma ferramenta que pode ser usada pelo modelo para pesquisar no Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search".

search_types array (enum (string))  (opcional)

Os tipos de embasamento de pesquisa a serem ativados.

Valores possíveis:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

Uma ferramenta que pode ser usada pelo modelo para pesquisar arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search".

file_search_store_names array (string)  (opcional)

Os nomes das lojas de pesquisa de arquivos a serem pesquisados.

top_k integer  (opcional)

O número de partes da recuperação semântica a serem recuperadas.

metadata_filter string  (opcional)

Filtro de metadados a ser aplicado aos documentos e partes da recuperação semântica.

GoogleMaps

Uma ferramenta que pode ser usada pelo modelo para chamar o Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps".

enable_widget booleano  (opcional)

Se é necessário retornar um token de contexto de widget no resultado da chamada de função da resposta.

latitude number  (opcional)

A latitude da localização do usuário.

longitude number  (optional)

A longitude da localização do usuário.

Recuperação

Uma ferramenta que pode ser usada pelo modelo para recuperar arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "retrieval".

retrieval_types array (enum (string))  (opcional)

Os tipos de recuperação de arquivos a serem ativados.

Valores possíveis:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig  (opcional)

Usado para especificar a configuração do VertexAISearch.

Usado para especificar a configuração do VertexAISearch.

Campos

engine string  (opcional)

Opcional. Usado para especificar o Vertex AI para Pesquisa.

datastores array (string)  (opcional)

Opcional. Usado para especificar repositórios de dados da Vertex AI para Pesquisa.

usage Usage  (opcional)

Apenas saída. Estatísticas sobre o uso de tokens da solicitação de interação.

Estatísticas sobre o uso de tokens da solicitação de interação.

Campos

total_input_tokens integer  (optional)

Número de tokens no comando (contexto).

input_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de entrada por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_cached_tokens integer  (optional)

Número de tokens na parte em cache do comando (o conteúdo em cache).

cached_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens armazenados em cache por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_output_tokens integer  (optional)

Número total de tokens em todas as respostas geradas.

output_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de saída por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_tool_use_tokens integer  (optional)

Número de tokens presentes nos comandos de uso da ferramenta.

tool_use_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de uso de ferramentas por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_thought_tokens integer  (opcional)

Número de tokens de ideias para modelos de pensamento.

total_tokens integer  (opcional)

Contagem total de tokens para a solicitação de interação (comando + respostas + outros tokens internos).

grounding_tool_count GroundingToolCount  (opcional)

Contagem de ferramentas de embasamento.

O número de contagens de ferramentas de embasamento.

Campos

type enum (string)  (opcional)

O tipo de ferramenta de embasamento associado à contagem.

Valores possíveis:

  • google_search
  • google_maps
  • retrieval
count integer  (opcional)

O número de contagens de ferramentas de embasamento.

response_modalities ResponseModality  (opcional)

As modalidades solicitadas da resposta (TEXT, IMAGE, AUDIO).

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

response_mime_type string  (opcional)

O tipo MIME da resposta. Obrigatório se "response_format" estiver definido.

previous_interaction_id string  (opcional)

O ID da interação anterior, se houver.

service_tier ServiceTier  (opcional)

O nível de serviço da interação.

Valores possíveis:

  • flex
  • standard
  • priority

webhook_config WebhookConfig  (opcional)

Opcional. Configuração de webhook para receber notificações quando a interação for concluída.

Mensagem para configurar eventos de webhook para uma solicitação.

Campos

uris array (string)  (opcional)

Opcional. Se definido, esses URIs de webhook serão usados para eventos de webhook em vez dos webhooks registrados.

user_metadata object  (opcional)

Opcional. Os metadados do usuário que serão retornados em cada emissão de evento para os webhooks.

steps Step  (opcional)

Apenas saída. As etapas que compõem a interação.

Uma etapa na interação.

Tipos possíveis

Discriminador polimórfico: type

UserInputStep

Entrada fornecida pelo usuário.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "user_input".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

Saída gerada pelo modelo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "model_output".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

Uma etapa de pensamento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "thought".

signature string  (opcional)

Um hash de assinatura para validação de back-end.

summary ThoughtSummaryContent  (opcional)

Um resumo do pensamento.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

Uma etapa de chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta a ser chamada.

arguments object  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

CodeExecutionCallStep

Etapa de chamada de execução de código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

Obrigatório. Os argumentos a serem transmitidos para a execução do código.

Os argumentos a serem transmitidos para a execução do código.

Campos

language enum (string)  (opcional)

Linguagem de programação do "code".

Valores possíveis:

  • python
code string  (opcional)

O código a ser executado.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextCallStep

Etapa de chamada de contexto de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_call".

arguments UrlContextCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para o contexto do URL.

Os argumentos a serem transmitidos para o contexto do URL.

Campos

urls array (string)  (opcional)

Os URLs a serem buscados.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolCallStep

Etapa de chamada de ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta que foi chamada.

server_name string  (obrigatório)

Obrigatório. O nome do servidor MCP usado.

arguments object  (obrigatório)

Obrigatório. O objeto JSON de argumentos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchCallStep

Etapa de chamada da Pesquisa Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_call".

argumentos GoogleSearchCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a Pesquisa Google.

Os argumentos a serem transmitidos para a Pesquisa Google.

Campos

queries array (string)  (opcional)

Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.

search_type enum (string)  (opcional)

O tipo de embasamento de pesquisa ativado.

Valores possíveis:

  • web_search
  • image_search
  • enterprise_web_search
id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FileSearchCallStep

Etapa de chamada da Pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_call".

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsCallStep

Etapa de chamada do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_call".

arguments GoogleMapsCallStepArguments  (opcional)

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Campos

queries array (string)  (opcional)

As consultas a serem executadas.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FunctionResultStep

Resultado de uma chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_result".

name string  (opcional)

O nome da ferramenta que foi chamada.

is_error boolean  (opcional)

Se a chamada de ferramenta resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

O resultado da chamada de função.

CodeExecutionResultStep

Etapa de resultado da execução do código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_result".

result string  (obrigatório)

Obrigatório. A saída da execução do código.

is_error boolean  (opcional)

Se a execução do código resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextResultStep

Etapa de resultado do contexto do URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_result".

result UrlContextResultItem  (obrigatório)

Obrigatório. Os resultados do contexto do URL.

O resultado do contexto do URL.

Campos

url string  (opcional)

O URL buscado.

status enum (string)  (opcional)

O status da recuperação do URL.

Valores possíveis:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (opcional)

Indica se o contexto do URL resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchResultStep

Etapa de resultado da pesquisa do Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_result".

result GoogleSearchResultItem  (obrigatório)

Obrigatório. Os resultados da Pesquisa Google.

O resultado da Pesquisa Google.

Campos

search_suggestions string  (opcional)

Snippet de conteúdo da Web que pode ser incorporado a uma página da Web ou a uma WebView de app.

is_error boolean  (opcional)

Se a Pesquisa Google resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolResultStep

Etapa de resultado da ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_result".

name string  (opcional)

Nome da ferramenta chamada para essa chamada de ferramenta específica.

server_name string  (opcional)

O nome do servidor MCP usado.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

A saída da chamada do servidor MCP. Pode ser texto simples ou conteúdo avançado.

FileSearchResultStep

Etapa de resultado da pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_result".

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsResultStep

Etapa de resultado do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_result".

result GoogleMapsResultItem  (obrigatório)

Nenhuma descrição informada.

O resultado do Google Maps.

Campos

places GoogleMapsResultPlaces  (opcional)

Nenhuma descrição informada.

Campos

place_id string  (opcional)

Nenhuma descrição informada.

name string  (opcional)

Nenhuma descrição informada.

url string  (opcional)

Nenhuma descrição informada.

review_snippets ReviewSnippet  (opcional)

Nenhuma descrição informada.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

widget_context_token string  (opcional)

Nenhuma descrição informada.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

input Content ou matriz (Content) ou matriz (Step) ou string  (opcional)

A entrada da interação.

response_format ResponseFormat ou ResponseFormatList  (opcional)

Garante que a resposta gerada seja um objeto JSON em conformidade com o esquema JSON especificado neste campo.

agent_config object  (opcional)

Parâmetros de configuração para a interação do agente.

Tipos possíveis

Discriminador polimórfico: type

DynamicAgentConfig

Configuração para agentes dinâmicos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "dynamic".

DeepResearchAgentConfig

Configuração do agente Deep Research.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "deep-research".

thinking_summaries ThinkingSummaries  (opcional)

Define se os resumos de pensamento serão incluídos na resposta.

Valores possíveis:

  • auto
  • none

visualization enum (string)  (opcional)

Define se as visualizações serão incluídas na resposta.

Valores possíveis:

  • off
  • auto
collaborative_planning boolean  (opcional)

Ativa o planejamento human-in-the-loop para o agente Deep Research. Se definido como "true", o agente Deep Research vai fornecer um plano de pesquisa na resposta. O agente só vai continuar se o usuário confirmar o plano na próxima interação.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

InteractionCompletedEvent

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "interaction.completed".

interaction Interaction  (obrigatório)

Obrigatório. A interação concluída com saídas vazias para reduzir o tamanho do payload. Use os eventos ContentDelta anteriores para a saída real.

O recurso "Interaction".

Campos

model ModelOption  (opcional)

O nome do "Model" usado para gerar a interação.

Valores possíveis:

  • gemini-2.5-computer-use-preview-10-2025

    Um modelo de capacidade de agente projetado para interação direta com a interface, permitindo que o Gemini perceba e navegue em ambientes digitais.

  • gemini-2.5-flash

    Nosso primeiro modelo de raciocínio híbrido, que oferece suporte a uma janela de contexto de 1 milhão de tokens e tem limites de raciocínio.

  • gemini-2.5-flash-image

    Nosso modelo nativo de geração de imagens, otimizado para velocidade, flexibilidade e compreensão contextual. A entrada e a saída de texto têm o mesmo preço do 2.5 Flash.

  • gemini-2.5-flash-lite

    Nosso modelo menor e mais econômico, criado para uso em grande escala.

  • gemini-2.5-flash-lite-preview-09-2025

    O modelo mais recente baseado no Gemini 2.5 Flash lite otimizado para custo-benefício, alta capacidade de processamento e alta qualidade.

  • gemini-2.5-flash-native-audio-preview-12-2025

    Nossos modelos de áudio nativos são otimizados para saídas de áudio de maior qualidade, com melhor ritmo, naturalidade da voz, nível de detalhes e humor.

  • gemini-2.5-flash-preview-09-2025

    O modelo mais recente baseado no modelo 2.5 Flash. O pré-lançamento do 2.5 Flash é ideal para processamento em grande escala, baixa latência, tarefas de alto volume que exigem raciocínio e casos de uso de agentes.

  • gemini-2.5-flash-preview-tts

    Nosso modelo de conversão de texto em voz 2.5 Flash otimizado para geração de fala controlável, potente e de baixa latência.

  • gemini-2.5-pro

    Nosso modelo multifuncional de última geração, que se destaca em programação e tarefas de raciocínio complexas.

  • gemini-2.5-pro-preview-tts

    Nosso modelo de áudio Text-to-Speech 2.5 Pro é otimizado para geração de fala poderosa e de baixa latência, com saídas mais naturais e comandos mais fáceis de direcionar.

  • gemini-3-flash-preview

    Nosso modelo mais inteligente, criado para ser rápido, combinando inteligência de ponta com pesquisa e embasamento superiores.

  • gemini-3-pro-image-preview

    Modelo de edição e geração de imagens de última geração.

  • gemini-3-pro-preview

    Nosso modelo mais inteligente com raciocínio e compreensão multimodal de última geração, além de recursos avançados de programação assistida por IA e vibe coding.

  • gemini-3.1-pro-preview

    Nosso mais recente modelo de raciocínio SOTA com profundidade e nuances sem precedentes, além de recursos avançados de compreensão multimodal e programação.

  • gemini-3.1-flash-image-preview

    Inteligência visual de nível profissional com eficiência de velocidade do Flash e recursos de geração baseados na realidade.

  • gemini-3.1-flash-lite-preview

    Nosso modelo mais econômico, otimizado para tarefas agentivas de alto volume, tradução e processamento de dados simples.

  • gemini-3.1-flash-tts-preview

    Gemini 3.1 Flash TTS: geração de fala eficiente e de baixa latência. Aproveite saídas naturais, comandos direcionáveis e novas tags de áudio expressivas para um controle preciso da narração.

  • lyria-3-clip-preview

    Nosso modelo de geração de música de baixa latência otimizado para clipes de áudio de alta fidelidade e controle rítmico preciso.

  • lyria-3-pro-preview

    Nosso modelo generativo avançado de músicas completas com compreensão composicional profunda, otimizado para controle estrutural preciso e transições complexas em diversos estilos musicais.

O modelo que vai concluir seu comando.\n\nConsulte [modelos](https://ai.google.dev/gemini-api/docs/models) para mais detalhes.

agent AgentOption  (opcional)

O nome do "Agente" usado para gerar a interação.

Valores possíveis:

  • deep-research-pro-preview-12-2025

    Agente Deep Research do Gemini

  • deep-research-preview-04-2026

    Agente Deep Research do Gemini

  • deep-research-max-preview-04-2026

    Agente Deep Research Max do Gemini

O agente com quem interagir.

id string  (opcional)

Obrigatório. Apenas saída. Um identificador exclusivo para a conclusão da interação.

status enum (string)  (opcional)

Obrigatório. Apenas saída. O status da interação.

Valores possíveis:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
created string  (opcional)

Obrigatório. Apenas saída. O horário em que a resposta foi criada no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).

updated string  (opcional)

Obrigatório. Apenas saída. A hora em que a resposta foi atualizada pela última vez no formato ISO 8601 (AAAA-MM-DDThh:mm:ssZ).

role string  (opcional)

Apenas saída. A função da interação.

system_instruction string  (opcional)

Instrução do sistema para a interação.

ferramentas Ferramenta  (opcional)

Uma lista de declarações de ferramentas que o modelo pode chamar durante a interação.

Uma ferramenta que pode ser usada pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

Função

Uma ferramenta que pode ser usada pelo modelo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function".

name string  (opcional)

O nome da função.

description string  (opcional)

Uma descrição da função.

parameters object  (opcional)

O esquema JSON para os parâmetros da função.

CodeExecution

Uma ferramenta que pode ser usada pelo modelo para executar código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution".

UrlContext

Uma ferramenta que pode ser usada pelo modelo para buscar o contexto do URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context".

ComputerUse

Uma ferramenta que pode ser usada pelo modelo para interagir com o computador.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "computer_use".

environment enum (string)  (opcional)

O ambiente em operação.

Valores possíveis:

  • browser
excluded_predefined_functions array (string)  (opcional)

A lista de funções predefinidas que são excluídas da chamada de modelo.

McpServer

Um MCPServer é um servidor que pode ser chamado pelo modelo para realizar ações.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server".

name string  (opcional)

O nome do MCPServer.

url string  (opcional)

O URL completo do endpoint MCPServer. Exemplo: "https://api.example.com/mcp"

headers object  (opcional)

Opcional: campos para cabeçalhos de autenticação, tempos limite etc., se necessário.

allowed_tools AllowedTools  (opcional)

As ferramentas permitidas.

A configuração para ferramentas permitidas.

Campos

mode ToolChoiceType  (opcional)

O modo da escolha de ferramenta.

Valores possíveis:

  • auto
  • any
  • none
  • validated

tools array (string)  (opcional)

Os nomes das ferramentas permitidas.

GoogleSearch

Uma ferramenta que pode ser usada pelo modelo para pesquisar no Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search".

search_types array (enum (string))  (opcional)

Os tipos de embasamento de pesquisa a serem ativados.

Valores possíveis:

  • web_search
  • image_search
  • enterprise_web_search
FileSearch

Uma ferramenta que pode ser usada pelo modelo para pesquisar arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search".

file_search_store_names array (string)  (opcional)

Os nomes das lojas de pesquisa de arquivos a serem pesquisados.

top_k integer  (opcional)

O número de partes da recuperação semântica a serem recuperadas.

metadata_filter string  (opcional)

Filtro de metadados a ser aplicado aos documentos e partes da recuperação semântica.

GoogleMaps

Uma ferramenta que pode ser usada pelo modelo para chamar o Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps".

enable_widget booleano  (opcional)

Se é necessário retornar um token de contexto de widget no resultado da chamada de função da resposta.

latitude number  (opcional)

A latitude da localização do usuário.

longitude number  (optional)

A longitude da localização do usuário.

Recuperação

Uma ferramenta que pode ser usada pelo modelo para recuperar arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "retrieval".

retrieval_types array (enum (string))  (opcional)

Os tipos de recuperação de arquivos a serem ativados.

Valores possíveis:

  • vertex_ai_search
vertex_ai_search_config VertexAISearchConfig  (opcional)

Usado para especificar a configuração do VertexAISearch.

Usado para especificar a configuração do VertexAISearch.

Campos

engine string  (opcional)

Opcional. Usado para especificar o Vertex AI para Pesquisa.

datastores array (string)  (opcional)

Opcional. Usado para especificar repositórios de dados da Vertex AI para Pesquisa.

usage Usage  (opcional)

Apenas saída. Estatísticas sobre o uso de tokens da solicitação de interação.

Estatísticas sobre o uso de tokens da solicitação de interação.

Campos

total_input_tokens integer  (optional)

Número de tokens no comando (contexto).

input_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de entrada por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_cached_tokens integer  (optional)

Número de tokens na parte em cache do comando (o conteúdo em cache).

cached_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens armazenados em cache por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_output_tokens integer  (optional)

Número total de tokens em todas as respostas geradas.

output_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de saída por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_tool_use_tokens integer  (optional)

Número de tokens presentes nos comandos de uso da ferramenta.

tool_use_tokens_by_modality ModalityTokens  (opcional)

Um detalhamento do uso de tokens de uso de ferramentas por modalidade.

A contagem de tokens para uma única modalidade de resposta.

Campos

modalidade ResponseModality  (opcional)

A modalidade associada à contagem de tokens.

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

tokens integer  (opcional)

Número de tokens para a modalidade.

total_thought_tokens integer  (opcional)

Número de tokens de ideias para modelos de pensamento.

total_tokens integer  (opcional)

Contagem total de tokens para a solicitação de interação (comando + respostas + outros tokens internos).

grounding_tool_count GroundingToolCount  (opcional)

Contagem de ferramentas de embasamento.

O número de contagens de ferramentas de embasamento.

Campos

type enum (string)  (opcional)

O tipo de ferramenta de embasamento associado à contagem.

Valores possíveis:

  • google_search
  • google_maps
  • retrieval
count integer  (opcional)

O número de contagens de ferramentas de embasamento.

response_modalities ResponseModality  (opcional)

As modalidades solicitadas da resposta (TEXT, IMAGE, AUDIO).

Valores possíveis:

  • text
  • image
  • audio
  • video
  • document

response_mime_type string  (opcional)

O tipo MIME da resposta. Obrigatório se "response_format" estiver definido.

previous_interaction_id string  (opcional)

O ID da interação anterior, se houver.

service_tier ServiceTier  (opcional)

O nível de serviço da interação.

Valores possíveis:

  • flex
  • standard
  • priority

webhook_config WebhookConfig  (opcional)

Opcional. Configuração de webhook para receber notificações quando a interação for concluída.

Mensagem para configurar eventos de webhook para uma solicitação.

Campos

uris array (string)  (opcional)

Opcional. Se definido, esses URIs de webhook serão usados para eventos de webhook em vez dos webhooks registrados.

user_metadata object  (opcional)

Opcional. Os metadados do usuário que serão retornados em cada emissão de evento para os webhooks.

steps Step  (opcional)

Apenas saída. As etapas que compõem a interação.

Uma etapa na interação.

Tipos possíveis

Discriminador polimórfico: type

UserInputStep

Entrada fornecida pelo usuário.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "user_input".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

Saída gerada pelo modelo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "model_output".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

Uma etapa de pensamento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "thought".

signature string  (opcional)

Um hash de assinatura para validação de back-end.

summary ThoughtSummaryContent  (opcional)

Um resumo do pensamento.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

Uma etapa de chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta a ser chamada.

arguments object  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

CodeExecutionCallStep

Etapa de chamada de execução de código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

Obrigatório. Os argumentos a serem transmitidos para a execução do código.

Os argumentos a serem transmitidos para a execução do código.

Campos

language enum (string)  (opcional)

Linguagem de programação do "code".

Valores possíveis:

  • python
code string  (opcional)

O código a ser executado.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextCallStep

Etapa de chamada de contexto de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_call".

arguments UrlContextCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para o contexto do URL.

Os argumentos a serem transmitidos para o contexto do URL.

Campos

urls array (string)  (opcional)

Os URLs a serem buscados.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolCallStep

Etapa de chamada de ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta que foi chamada.

server_name string  (obrigatório)

Obrigatório. O nome do servidor MCP usado.

arguments object  (obrigatório)

Obrigatório. O objeto JSON de argumentos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchCallStep

Etapa de chamada da Pesquisa Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_call".

argumentos GoogleSearchCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a Pesquisa Google.

Os argumentos a serem transmitidos para a Pesquisa Google.

Campos

queries array (string)  (opcional)

Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.

search_type enum (string)  (opcional)

O tipo de embasamento de pesquisa ativado.

Valores possíveis:

  • web_search
  • image_search
  • enterprise_web_search
id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FileSearchCallStep

Etapa de chamada da Pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_call".

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsCallStep

Etapa de chamada do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_call".

arguments GoogleMapsCallStepArguments  (opcional)

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Campos

queries array (string)  (opcional)

As consultas a serem executadas.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FunctionResultStep

Resultado de uma chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_result".

name string  (opcional)

O nome da ferramenta que foi chamada.

is_error boolean  (opcional)

Se a chamada de ferramenta resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

O resultado da chamada de função.

CodeExecutionResultStep

Etapa de resultado da execução do código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_result".

result string  (obrigatório)

Obrigatório. A saída da execução do código.

is_error boolean  (opcional)

Se a execução do código resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextResultStep

Etapa de resultado do contexto do URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_result".

result UrlContextResultItem  (obrigatório)

Obrigatório. Os resultados do contexto do URL.

O resultado do contexto do URL.

Campos

url string  (opcional)

O URL buscado.

status enum (string)  (opcional)

O status da recuperação do URL.

Valores possíveis:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (opcional)

Indica se o contexto do URL resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchResultStep

Etapa de resultado da pesquisa do Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_result".

result GoogleSearchResultItem  (obrigatório)

Obrigatório. Os resultados da Pesquisa Google.

O resultado da Pesquisa Google.

Campos

search_suggestions string  (opcional)

Snippet de conteúdo da Web que pode ser incorporado a uma página da Web ou a uma WebView de app.

is_error boolean  (opcional)

Se a Pesquisa Google resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolResultStep

Etapa de resultado da ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_result".

name string  (opcional)

Nome da ferramenta chamada para essa chamada de ferramenta específica.

server_name string  (opcional)

O nome do servidor MCP usado.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

A saída da chamada do servidor MCP. Pode ser texto simples ou conteúdo avançado.

FileSearchResultStep

Etapa de resultado da pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_result".

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsResultStep

Etapa de resultado do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_result".

result GoogleMapsResultItem  (obrigatório)

Nenhuma descrição informada.

O resultado do Google Maps.

Campos

places GoogleMapsResultPlaces  (opcional)

Nenhuma descrição informada.

Campos

place_id string  (opcional)

Nenhuma descrição informada.

name string  (opcional)

Nenhuma descrição informada.

url string  (opcional)

Nenhuma descrição informada.

review_snippets ReviewSnippet  (opcional)

Nenhuma descrição informada.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

widget_context_token string  (opcional)

Nenhuma descrição informada.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

input Content ou matriz (Content) ou matriz (Step) ou string  (opcional)

A entrada para a interação.

response_format ResponseFormat ou ResponseFormatList  (opcional)

Garante que a resposta gerada seja um objeto JSON em conformidade com o esquema JSON especificado neste campo.

agent_config object  (opcional)

Parâmetros de configuração para a interação do agente.

Tipos possíveis

Discriminador polimórfico: type

DynamicAgentConfig

Configuração para agentes dinâmicos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "dynamic".

DeepResearchAgentConfig

Configuração do agente Deep Research.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "deep-research".

thinking_summaries ThinkingSummaries  (opcional)

Define se os resumos de pensamento serão incluídos na resposta.

Valores possíveis:

  • auto
  • none

visualization enum (string)  (opcional)

Define se as visualizações serão incluídas na resposta.

Valores possíveis:

  • off
  • auto
collaborative_planning boolean  (opcional)

Ativa o planejamento human-in-the-loop para o agente Deep Research. Se definido como "true", o agente Deep Research vai fornecer um plano de pesquisa na resposta. O agente só vai continuar se o usuário confirmar o plano na próxima interação.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

InteractionStatusUpdate

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "interaction.status_update".

interaction_id string  (obrigatório)

Nenhuma descrição informada.

status enum (string)  (obrigatório)

Nenhuma descrição informada.

Valores possíveis:

  • in_progress
  • requires_action
  • completed
  • failed
  • cancelled
  • incomplete
event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

ErrorEvent

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "error".

error Error  (opcional)

Nenhuma descrição informada.

Mensagem de erro de uma interação.

Campos

code string  (opcional)

Um URI que identifica o tipo de erro.

message string  (opcional)

Uma mensagem de erro legível.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

StepStart

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "step.start".

index integer  (obrigatório)

Nenhuma descrição informada.

step Step  (obrigatório)

Nenhuma descrição informada.

Uma etapa na interação.

Tipos possíveis

Discriminador polimórfico: type

UserInputStep

Entrada fornecida pelo usuário.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "user_input".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ModelOutputStep

Saída gerada pelo modelo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "model_output".

content Content  (opcional)

Nenhuma descrição informada.

O conteúdo da resposta.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioContent

Um bloco de conteúdo de áudio.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

O conteúdo de áudio.

uri string  (opcional)

O URI do áudio.

mime_type enum (string)  (opcional)

O tipo MIME do áudio.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
channels integer  (opcional)

O número de canais de áudio.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

DocumentContent

Um bloco de conteúdo de documento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

O conteúdo do documento.

uri string  (opcional)

O URI do documento.

mime_type enum (string)  (opcional)

O tipo MIME do documento.

Valores possíveis:

  • application/pdf
VideoContent

Um bloco de conteúdo em vídeo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

O conteúdo do vídeo.

uri string  (opcional)

O URI do vídeo.

mime_type enum (string)  (opcional)

O tipo MIME do vídeo.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ThoughtStep

Uma etapa de pensamento.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "thought".

signature string  (opcional)

Um hash de assinatura para validação de back-end.

summary ThoughtSummaryContent  (opcional)

Um resumo do pensamento.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

FunctionCallStep

Uma etapa de chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta a ser chamada.

arguments object  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

CodeExecutionCallStep

Etapa de chamada de execução de código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_call".

arguments CodeExecutionCallStepArguments  (required)

Obrigatório. Os argumentos a serem transmitidos para a execução do código.

Os argumentos a serem transmitidos para a execução do código.

Campos

language enum (string)  (opcional)

Linguagem de programação do "code".

Valores possíveis:

  • python
code string  (opcional)

O código a ser executado.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextCallStep

Etapa de chamada de contexto de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_call".

arguments UrlContextCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para o contexto do URL.

Os argumentos a serem transmitidos para o contexto do URL.

Campos

urls array (string)  (opcional)

Os URLs a serem buscados.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolCallStep

Etapa de chamada de ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_call".

name string  (obrigatório)

Obrigatório. O nome da ferramenta que foi chamada.

server_name string  (obrigatório)

Obrigatório. O nome do servidor MCP usado.

arguments object  (obrigatório)

Obrigatório. O objeto JSON de argumentos para a função.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchCallStep

Etapa de chamada da Pesquisa Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_call".

argumentos GoogleSearchCallStepArguments  (obrigatório)

Obrigatório. Os argumentos a serem transmitidos para a Pesquisa Google.

Os argumentos a serem transmitidos para a Pesquisa Google.

Campos

queries array (string)  (opcional)

Consultas de pesquisa na Web para a pesquisa na Web de acompanhamento.

search_type enum (string)  (opcional)

O tipo de embasamento de pesquisa ativado.

Valores possíveis:

  • web_search
  • image_search
  • enterprise_web_search
id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FileSearchCallStep

Etapa de chamada da Pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_call".

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsCallStep

Etapa de chamada do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_call".

arguments GoogleMapsCallStepArguments  (opcional)

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Os argumentos a serem transmitidos para a ferramenta do Google Maps.

Campos

queries array (string)  (opcional)

As consultas a serem executadas.

id string  (obrigatório)

Obrigatório. Um ID exclusivo para essa chamada de função específica.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

FunctionResultStep

Resultado de uma chamada de ferramenta de função.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "function_result".

name string  (opcional)

O nome da ferramenta que foi chamada.

is_error boolean  (opcional)

Se a chamada de ferramenta resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

O resultado da chamada de função.

CodeExecutionResultStep

Etapa de resultado da execução do código.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "code_execution_result".

result string  (obrigatório)

Obrigatório. A saída da execução do código.

is_error boolean  (opcional)

Se a execução do código resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

UrlContextResultStep

Etapa de resultado do contexto do URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_context_result".

result UrlContextResultItem  (obrigatório)

Obrigatório. Os resultados do contexto do URL.

O resultado do contexto do URL.

Campos

url string  (opcional)

O URL buscado.

status enum (string)  (opcional)

O status da recuperação do URL.

Valores possíveis:

  • success
  • error
  • paywall
  • unsafe
is_error boolean  (opcional)

Indica se o contexto do URL resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleSearchResultStep

Etapa de resultado da pesquisa do Google.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_search_result".

result GoogleSearchResultItem  (obrigatório)

Obrigatório. Os resultados da Pesquisa Google.

O resultado da Pesquisa Google.

Campos

search_suggestions string  (opcional)

Snippet de conteúdo da Web que pode ser incorporado a uma página da Web ou a uma WebView de app.

is_error boolean  (opcional)

Se a Pesquisa Google resultou em um erro.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

McpServerToolResultStep

Etapa de resultado da ferramenta MCPServer.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "mcp_server_tool_result".

name string  (opcional)

Nome da ferramenta chamada para essa chamada de ferramenta específica.

server_name string  (opcional)

O nome do servidor MCP usado.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

result array (FunctionResultSubcontent) or string  (required)

A saída da chamada do servidor MCP. Pode ser texto simples ou conteúdo avançado.

FileSearchResultStep

Etapa de resultado da pesquisa de arquivos.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_search_result".

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

GoogleMapsResultStep

Etapa de resultado do Google Maps.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "google_maps_result".

result GoogleMapsResultItem  (obrigatório)

Nenhuma descrição informada.

O resultado do Google Maps.

Campos

places GoogleMapsResultPlaces  (opcional)

Nenhuma descrição informada.

Campos

place_id string  (opcional)

Nenhuma descrição informada.

name string  (opcional)

Nenhuma descrição informada.

url string  (opcional)

Nenhuma descrição informada.

review_snippets ReviewSnippet  (opcional)

Nenhuma descrição informada.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

widget_context_token string  (opcional)

Nenhuma descrição informada.

call_id string  (obrigatório)

Obrigatório. ID para corresponder ao ID do bloco de chamada de função.

signature string  (opcional)

Um hash de assinatura para validação de back-end.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

StepDelta

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "step.delta".

index integer  (obrigatório)

Nenhuma descrição informada.

delta StepDeltaData  (obrigatório)

Nenhuma descrição informada.

Tipos possíveis

Discriminador polimórfico: type

TextDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Nenhuma descrição informada.

ImageDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

Nenhuma descrição informada.

uri string  (opcional)

Nenhuma descrição informada.

mime_type enum (string)  (opcional)

Nenhuma descrição informada.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

AudioDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "audio".

data string  (opcional)

Nenhuma descrição informada.

uri string  (opcional)

Nenhuma descrição informada.

mime_type enum (string)  (opcional)

Nenhuma descrição informada.

Valores possíveis:

  • audio/wav
  • audio/mp3
  • audio/aiff
  • audio/aac
  • audio/ogg
  • audio/flac
  • audio/mpeg
  • audio/m4a
  • audio/l16
  • audio/opus
  • audio/alaw
  • audio/mulaw
rate integer  (opcional)

Obsoleto. Use "sample_rate". O valor é ignorado.

sample_rate integer  (opcional)

A taxa de amostragem do áudio.

channels integer  (opcional)

O número de canais de áudio.

DocumentDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "document".

data string  (opcional)

Nenhuma descrição informada.

uri string  (opcional)

Nenhuma descrição informada.

mime_type enum (string)  (opcional)

Nenhuma descrição informada.

Valores possíveis:

  • application/pdf
VideoDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "video".

data string  (opcional)

Nenhuma descrição informada.

uri string  (opcional)

Nenhuma descrição informada.

mime_type enum (string)  (opcional)

Nenhuma descrição informada.

Valores possíveis:

  • video/mp4
  • video/mpeg
  • video/mpg
  • video/mov
  • video/avi
  • video/x-flv
  • video/webm
  • video/wmv
  • video/3gpp
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ThoughtSummaryDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "thought_summary".

content ThoughtSummaryContent  (opcional)

Um novo item de resumo a ser adicionado ao pensamento.

Tipos possíveis

Discriminador polimórfico: type

TextContent

Um bloco de conteúdo de texto.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text".

text string  (obrigatório)

Obrigatório. O conteúdo do texto.

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ImageContent

Um bloco de conteúdo de imagem.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "image".

data string  (opcional)

O conteúdo da imagem.

uri string  (opcional)

O URI da imagem.

mime_type enum (string)  (opcional)

O tipo MIME da imagem.

Valores possíveis:

  • image/png
  • image/jpeg
  • image/webp
  • image/heic
  • image/heif
  • image/gif
  • image/bmp
  • image/tiff
resolution MediaResolution  (opcional)

A resolução da mídia.

Valores possíveis:

  • low
  • medium
  • high
  • ultra_high

ThoughtSignatureDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "thought_signature".

signature string  (opcional)

Assinatura para corresponder à origem do back-end que fará parte da geração.

TextAnnotationDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "text_annotation_delta".

annotations Annotation  (opcional)

Informações de citação para conteúdo gerado pelo modelo.

Informações de citação para conteúdo gerado pelo modelo.

Tipos possíveis

Discriminador polimórfico: type

UrlCitation

Uma anotação de citação de URL.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "url_citation".

url string  (opcional)

O URL.

title string  (opcional)

O título do URL.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

FileCitation

Uma anotação de citação de arquivo.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "file_citation".

document_uri string  (opcional)

O URI do arquivo.

file_name string  (opcional)

O nome do arquivo.

source string  (opcional)

Origem atribuída a uma parte do texto.

custom_metadata object  (opcional)

Metadados fornecidos pelo usuário sobre o contexto recuperado.

page_number integer  (opcional)

Número da página do documento citado, se aplicável.

media_id string  (opcional)

ID da mídia em caso de citações de imagens, se aplicável.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

PlaceCitation

Uma anotação de citação de lugar.

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "place_citation".

place_id string  (opcional)

O ID do lugar, no formato `places/{place_id}`.

name string  (opcional)

Título do lugar.

url string  (opcional)

Referência de URI do lugar.

review_snippets ReviewSnippet  (opcional)

Trechos de avaliações usados para gerar respostas sobre os recursos de um determinado lugar no Google Maps.

Encapsula um trecho de uma avaliação do usuário que responde a uma pergunta sobre os recursos de um lugar específico no Google Maps.

Campos

title string  (opcional)

Título da avaliação.

url string  (opcional)

Um link que corresponde à avaliação do usuário no Google Maps.

review_id string  (opcional)

O ID do snippet de avaliação.

start_index integer  (opcional)

Início do segmento da resposta atribuído a esta fonte. O índice indica o início do segmento, medido em bytes.

end_index integer  (opcional)

Fim do segmento atribuído, exclusivo.

ArgumentsDelta

type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "arguments_delta".

partial_arguments string  (opcional)

Nenhuma descrição informada.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

StepStop

event_type object  (obrigatório)

Nenhuma descrição informada.

Sempre defina como "step.stop".

index integer  (obrigatório)

Nenhuma descrição informada.

event_id string  (opcional)

O token event_id a ser usado para retomar o fluxo de interação, a partir deste evento.

Exemplos

Interação criada

{
  "event_type": "interaction.created",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "in_progress",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Interação concluída

{
  "event_type": "interaction.completed",
  "interaction": {
    "id": "v1_ChdXS0l4YWZXTk9xbk0xZThQczhEcmlROBIXV0tJeGFmV05PcW5NMWU4UHM4RHJpUTg",
    "model": "gemini-3-flash-preview",
    "status": "completed",
    "created": "2025-12-04T15:01:45Z",
    "updated": "2025-12-04T15:01:45Z"
  },
  "event_id": "evt_123"
}

Atualização do status da interação

{
  "event_type": "interaction.status_update",
  "interaction_id": "v1_ChdTMjQ0YWJ5TUF1TzcxZThQdjRpcnFRcxIXUzI0NGFieU1BdU83MWU4UHY0aXJxUXM",
  "status": "in_progress"
}

Evento de erro

{
  "event_type": "error",
  "error": {
    "message": "Failed to get completed interaction: Result not found.",
    "code": "not_found"
  }
}

Início da etapa

{
  "event_type": "step.start",
  "index": 0,
  "step": {
    "type": "model_output"
  }
}

Delta de etapa

{
  "event_type": "step.delta",
  "index": 0,
  "delta": {
    "type": "text",
    "text": "Hello"
  }
}

Step Stop

{
  "event_type": "step.stop",
  "index": 0
}