«Neuro Triumph» ~ Neural Network API Specification

Introduction 🙌

As you probably already understood, by adding your neural network to our platform, you essentially specify the server address with the API of your neural network.

Thus, during testing, messages from the test object (real user) will be sent to your API.
It is your responsibility to respond to this request in a specific format (this is essentially the API specification).

API Secret 🔐

To protect your API, you must also provide a password for your API.
It is specified when creating a neural network and is called "api secret".
When sending a request to your API, we will put it in the header:

API-Secret: <your api secret>

Endpoints 🎯

🟡 POST | Reply to message

This endpoint should receive the message from the HTTP request body, pass it to your neural network, and then put its response into the HTTP response body in JSON format.

/reply

# Request
{
  "message": <string>
}

# Response
{
  "message": <string>
}