Ler mensagem no Gmail, por uma API

Obtém uma mensagem com threadId, labelIds e snippet. Com format full, o padrão, payload traz os headers (From, To, Subject, Date, Message-ID) e as partes do corpo, cujo data vem em base64url. Anexos vêm apenas como attachmentId e não são baixados.

Identificador
gmail_get_message

A chamada

POST https://connect.reportei.com/api/tools/gmail_get_message/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "messageId": "<messageId>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
messageIdstringSimMessage id from List messages, or the message.id of a draft from List drafts.
formatstringNãofull returns the parsed payload, metadata only the headers, minimal only the ids and labels, and raw the whole RFC 2822 message base64url encoded in raw. The default is full.Valores: full, metadata, minimal, raw
metadataHeadersarrayNãoWith format metadata, returns only these headers, such as From, Subject and Message-ID.

Conexões possíveis

O seu cliente conecta a conta do Gmail uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/gmail, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/gmail_get_message. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Gmail

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.