Enviar uma mensagem para a Elo

Envia a mensagem e responde com o stream da resposta (text/event-stream): trechos de texto e de raciocínio, passos de ferramenta, cartões, tool_proposal com a proposta que espera aprovação e, no fim, done, error ou awaiting_approval.

CampoTipoRegra
contentstringo texto do usuário; vazio só com anexos ou quando há mensagens na fila (então só a fila é entregue)
attachmentsstring[]ids de mídia anexados
modelstringmodelo da conversa, opcional
reasoningstringnível de raciocínio, opcional: um dos reasoning.levels do modelo em GET /agents/options (none, minimal, low, medium, high, xhigh ou max); vazio usa o padrão do modelo. Fica guardado na conversa junto com o modelo e vale também para aprovações. Trocar de modelo sem enviar nível volta ao padrão do novo modelo
timezonestringfuso horário do usuário
modestringask (padrão), edit ou full
viewobjecta tela aberta; vazio fora das telas abaixo

view.surface é attendance (com dateFrom, dateTo em YYYY-MM-DD, departmentId, memberId, channel, campaignId, campaignType, includeAi), studio (com projectId e projectKind image ou video) ou leads. Na página Leads, view.leadFilter é o filtro efetivo da lista, no mesmo formato do parâmetro filter de GET /leads ({groups: [{conjunction, predicates: [{field, key, operator, values}]}]}, com a busca incluída como predicado query), até 16 KiB e validado como os filtros de lead; view.selectedLeads é quantos leads estão marcados na tabela (0 a 10.000.000). A Elo recebe só os nomes dos campos filtrados, nunca os valores, e usa o filtro quando uma ferramenta pede use_screen_filter. Campos de outra tela, filtro inválido ou contagem fora do intervalo respondem 400.

No Estúdio, a primeira resposta liga a conversa ao projeto aberto (view.projectId). Depois disso, um envio, uma aprovação ou uma recusa com outro projeto responde 409 com code: thread_other_project e nada roda: a Elo nunca edita um projeto com o histórico de outro. Fora do Estúdio a conversa continua normalmente.

Uma conversa tem uma resposta por vez: com outra resposta rodando, responde 409 com code: turn_running, e o cliente deixa a mensagem na fila (POST /chat/threads/{id}/queue). Mensagens que estavam na fila entram na conversa antes desta, com o evento delivered. Durante a resposta, mensagens da fila chegam à Elo entre um passo e outro (evento delivered, que divide a resposta em duas partes) e, se sobrar alguma no fim, a Elo responde a ela no mesmo stream, depois de done.

O idioma do pedido (parâmetro locale ou cabeçalho Accept-Language: pt, en, es ou de; pt quando ausente) é o idioma do que a Elo grava para o usuário, como a exportação de leads.

Propostas de ações sobre leads (prepare_lead_action, start_lead_send, cancel_lead_send) trazem preview.kind lead_action com data {stage: prepare|start|cancel, action, mode, previewId, matched, selected, eligible, partial, skipped: {motivo: n}, counted: {motivo: n}, quote, parts}; selected é o tamanho confirmado da seleção (o que a aprovação executa), e com partial verdadeiro eligible e skipped ainda estão sendo contados: o resultado final sai de GET /leads/actions/previews/{previewId}; quote é a cotação do envio (count, parts, splitRequired, unitPriceMicros, costMicros, balanceMicros, currency, affordable, capRemaining, fits, refusal, dailyCap, estimatedDays) e parts são as campanhas preparadas (campaignId, name, status, entries, eligible).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

conversa

Body Params

mensagem e tela aberta (campos na tabela acima)

Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/event-stream