API EvaGPT

Schemas

problemDetails

typestring · uri · required
titlestring · required
statusinteger · required
instancestring · required
Caminho da requisição.
traceobject · required
Identificadores da requisição no gateway. Informe o requestId ao suporte.

totalinteger | string · required
Total de agentes que atendem aos filtros. A partir da segunda página, ecoa o valor reenviado na query (como texto).
currentPageinteger · required
Número da página devolvida. A primeira é 1.
totalPagesinteger | string · required
Total de páginas para o limit informado. A partir da segunda página, ecoa o valor reenviado na query (como texto).
cursorstring | null · required
Cursor da próxima página (ID do último item desta). null quando a lista vem vazia.
botsobject[] · required

totalinteger | string · required
Total de conhecimentos que atendem aos filtros. A partir da segunda página, ecoa o valor reenviado na query (como texto).
currentPageinteger · required
Número da página devolvida. A primeira é 1.
totalPagesinteger | string · required
Total de páginas para o limit informado. A partir da segunda página, ecoa o valor reenviado na query (como texto).
cursorstring | null · required
Cursor da próxima página (ID do último item desta). null quando a lista vem vazia.
datasetsobject[] · required

idstring
ID da conversa.
namestring
Título da conversa (nome do agente na criação).
botidstring
ID do agente.
channelstring
Canal de origem. Conversas abertas por esta API vêm como gateway.
servicestring
createdAtstring · date-time
surveynumber
Nota da pesquisa de satisfação (1 a 5); 0 se não respondida.
feedbacksinteger
Quantidade de respostas avaliadas como positivas ou negativas.
closedboolean
Conversa encerrada.
tagsobject[]
Até 3 categorias atribuídas à conversa.
signalsobject[]
metadataobject
Metadados gravados na conversa (nome → valor).

idstring
ID da mensagem. Ausente na primeira interação, que é a apresentação do agente.
rolestring · enum
Quem enviou.
Enum values:
bot
user
namestring
Nome exibido de quem enviou.
typestring
Sempre text.
textstring
Texto da mensagem. Em mensagens de áudio, a transcrição.
createdAtstring · date-time
feedbackinteger · enum
Avaliação da resposta: 0 negativo, 1 positivo, 2 neutro (padrão).
Enum values:
0
1
2
filesobject[]
Arquivos anexados. Para baixar pela API, use [Baixar arquivo da conversa] com o name.
signalsobject[]
abuseNoticeboolean
Resposta automática enviada quando a conversa foi encerrada por uso abusivo.
usageobject
Consumo da resposta, em créditos (token). Pode estar ausente.

idstring · required
ID da mensagem do agente (use no feedback).
messagestring · required
Resposta do agente.
typestring · required
Sempre text.
sendMensagesobject[] · required
Respostas do turno. A grafia do campo é sendMensages.

textstring
Mensagem ou instrução sobre os arquivos. Envie sempre junto com os arquivos.
filesstring[]
Arquivos da mensagem: repita a parte files uma vez por arquivo. O nome do campo é files, sem colchetes. Tipos diferentes podem ir juntos.
filestring · binary
Um único arquivo. Alternativa a files; aceita uma parte só.
typestring · enum
Opcional com arquivos: o tipo de cada um é identificado pelo próprio arquivo, e type só é usado quando isso não for possível.
Enum values:
document
image
audio
text

problemDetails

typestring · uri · required
titlestring · required
statusinteger · required
instancestring · required
Caminho da requisição.
traceobject · required
Identificadores da requisição no gateway. Informe o requestId ao suporte.

signal

botList

totalinteger | string · required
Total de agentes que atendem aos filtros. A partir da segunda página, ecoa o valor reenviado na query (como texto).
currentPageinteger · required
Número da página devolvida. A primeira é 1.
totalPagesinteger | string · required
Total de páginas para o limit informado. A partir da segunda página, ecoa o valor reenviado na query (como texto).
cursorstring | null · required
Cursor da próxima página (ID do último item desta). null quando a lista vem vazia.
botsobject[] · required

datasetList

totalinteger | string · required
Total de conhecimentos que atendem aos filtros. A partir da segunda página, ecoa o valor reenviado na query (como texto).
currentPageinteger · required
Número da página devolvida. A primeira é 1.
totalPagesinteger | string · required
Total de páginas para o limit informado. A partir da segunda página, ecoa o valor reenviado na query (como texto).
cursorstring | null · required
Cursor da próxima página (ID do último item desta). null quando a lista vem vazia.
datasetsobject[] · required

conversationSummary

idstring
ID da conversa.
namestring
Título da conversa (nome do agente na criação).
botidstring
ID do agente.
channelstring
Canal de origem. Conversas abertas por esta API vêm como gateway.
servicestring
createdAtstring · date-time
surveynumber
Nota da pesquisa de satisfação (1 a 5); 0 se não respondida.
feedbacksinteger
Quantidade de respostas avaliadas como positivas ou negativas.
closedboolean
Conversa encerrada.
tagsobject[]
Até 3 categorias atribuídas à conversa.
signalsobject[]
metadataobject
Metadados gravados na conversa (nome → valor).

interaction

idstring
ID da mensagem. Ausente na primeira interação, que é a apresentação do agente.
rolestring · enum
Quem enviou.
Enum values:
bot
user
namestring
Nome exibido de quem enviou.
typestring
Sempre text.
textstring
Texto da mensagem. Em mensagens de áudio, a transcrição.
createdAtstring · date-time
feedbackinteger · enum
Avaliação da resposta: 0 negativo, 1 positivo, 2 neutro (padrão).
Enum values:
0
1
2
filesobject[]
Arquivos anexados. Para baixar pela API, use [Baixar arquivo da conversa] com o name.
signalsobject[]
abuseNoticeboolean
Resposta automática enviada quando a conversa foi encerrada por uso abusivo.
usageobject
Consumo da resposta, em créditos (token). Pode estar ausente.

multipartBody

textstring
Mensagem ou instrução sobre os arquivos. Envie sempre junto com os arquivos.
filesstring[]
Arquivos da mensagem: repita a parte files uma vez por arquivo. O nome do campo é files, sem colchetes. Tipos diferentes podem ir juntos.
filestring · binary
Um único arquivo. Alternativa a files; aceita uma parte só.
typestring · enum
Opcional com arquivos: o tipo de cada um é identificado pelo próprio arquivo, e type só é usado quando isso não for possível.
Enum values:
document
image
audio
text