API documentation for developers to integrate with the Sim and Teach endpoints.
The /sim endpoint is used to query a chatbot for a response. Use the query parameter to pass your text query.
HTTP Method: GET
Endpoint: /sim
Parameters:
query (string, required): The input message or query for the bot.Example Request:
GET /sim?query=hello
Example Response:
{
"author": "Jerome",
"status": 200,
"respond": "Hi! How can I help you?",
"processingTime": "12.34ms"
}
Test Now
The /teach endpoint is used to teach the chatbot new responses. Use the ask and ans parameters to pass the input query and the corresponding response.
HTTP Method: GET
Endpoint: /teach
Parameters:
ask (string, required): The input message or query to teach.ans (string, required): The response or answer to associate with the query.Example Request:
GET /teach?ask=How%20are%20you?&ans=I%20am%20good,%20thank%20you!
Example Response:
{
"author": "Jerome",
"status": 200,
"message": "Successfully taught the Bot Hosting API",
"processingTime": "15.67ms"
}
Test Now