Neurau API v1.0.0

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

Authentication

Sign into view and manage your API credentials

Verify connection

MAKE API CONNECTION VERIFICATION

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.

POST
/account/connections
1

Gerar resposta

Este método permite o envio de queries de um usuário id_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

id_agent

required, string

O ID de um agente Neurau.

id_user

required, string

O ID 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": "cupidatat in commodo enim"
    }
  }
}

Enviar mensagem como agente

Este método permite o envio de uma mensagem arbritraria ao usuário id_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

id_agent

required, string

O ID de um agente Neurau.

id_user

required, string

O ID 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": "eiusmod deserunt sunt elit"
    }
  }
}