logo
Index
API Reference
Gerar resposta
Enviar mensagem como agente
Listar contextos de conversa
powered by zuplo

Neurau API v0.2.0

BASE URL
https://neurau-main-f3bef85.zuplo.app

Gerar resposta

Este endereço permite o envio de queries de um usuário identificador_user ao agente Neurau id_agent, retornando a resposta gerada pelo agente. Todos os mesmos comportamentos de mensagens recebidas fora da API são observados, e.g. a inclusão da query+resposta no hístorico da conversa entre id_agent e id_user.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

agent_id

required, string

O identificador de um agente Neurau.

user_id

required, string

O identificador de um usuário (geralmente, um número de whatsapp)

Request Body

data

required, object
POST
/agents/:agent_id/conversations/:conversation_id/query
1
EXAMPLE BODY
{
  "data": {
    "query": {
      "text": "adipisicing laborum in voluptate irure"
    }
  }
}

Enviar mensagem como agente

Este endereço permite o envio de uma mensagem arbritraria ao usuário identificador_usuário. A mensagem é adicionada ao histórico de conversa entre id_agent e id_user para consideração em interações futuras.

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Path Parameters

agent_id

required, string

O identificador de um agente Neurau.

user_id

required, string

O identificador de um usuário (geralmente, um número de whatsapp)

Request Body

data

required, object
POST
/agents/:agent_id/conversations/:conversation_id/messages
1
EXAMPLE BODY
{
  "data": {
    "message": {
      "text": "mollit"
    }
  }
}

Listar contextos de conversa

Este endereço permite você listar conversas e informações extraídas de conversa

Protected by API Key

Headers

Authorization

required, string

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Query Parameters

pagination

optional, object

Objeto de paginação contendo os parâmetros page e per_page.

filters

optional, object

Objeto para filtros. Cada chave (por exemplo, 0, 1, …) deve definir um filtro com field.name, field.operator and field.value. Por exemplo, para filtrar todas as conversas criadas após 01/01/2000, use os parametros: ?filters[0][field][name]=created_at&filters[0][field][operator]=greater_than&filters[0][field][value]=2000-01-01T00:00:00.000Z

orders

optional, object

Objeto para ordenação. Cada chave (por exemplo, 0, 1, …) deve definir um order com field.name e field.direction. Por exemplo, para ordenar todas a conversar por data de criação, use os parametros ?orders[0][name]=created_at&orders[0][direction]=desc

Path Parameters

agent_id

required, string

O identificador de um agente Neurau.

GET
/agents/:agent_id/contexts
1