Skip to content

Enviar mensagem ao assistente​

POST
/tenant/ai/chat

Manda uma pergunta ao assistente do Chat com Dados em nome de um usuário do Tenant e devolve a resposta. O assistente consulta os dados com o acesso desse usuário: só vê as Aplicações e tabelas que ele vê, com as mesmas restrições de linha e coluna.

A resposta vem em streaming (SSE) por padrão. Para receber tudo de uma vez em JSON, mande ?stream=false ou o header Accept: application/json. O formato dos eventos, com exemplos em Node.js e Python, está em Streaming do chat.

Sem threadId, a mensagem abre uma conversa nova, e o id dela chega no evento thread (ou em threadId, no modo JSON). Mande esse id nas próximas mensagens para o assistente lembrar o que já foi dito.

O userId precisa ser de um usuário ativo no Tenant e com permissão de IA. Para achar o id a partir do e-mail, use GET /tenant/users?email=.

Erros

No modo SSE, só a validação do corpo responde com status de erro (400). O resto chega como evento error dentro de uma resposta HTTP 200. No modo JSON:

Status code Causa
400 VALIDATION_ERROR Corpo inválido
403 REQUEST_FAILED Usuário fora do Tenant, inativo ou sem permissão de IA
404 NOT_FOUND threadId que não existe, ou de outro usuário
500 INTERNAL_ERROR Falha ao gerar a resposta

Autorizações​

tenantBearerAuth

Token de acesso do tenant

TipoHTTP (bearer)

Parâmetros​

Query Parameters

stream

Com false, a resposta vem em JSON de uma vez. Com true, vem em SSE mesmo com Accept: application/json

Tipostring
Valid values
"true""false"
Example"false"

Corpo da Requisição​

application/json
JSON

Respostas​

Resposta do assistente, em SSE ou JSON

JSON

Playground​

Autorização
Variáveis
Chave
Valor
Corpo

Exemplos​

Desenvolvido por VitePress OpenAPI