Get answer

This API documenation will help the integrator understand how a user query will be answered with the help of API request.

By Sagarika and Sanket


The API endpoint allows you to make an HTTP POST request to {ngrok-link}/get_response in order to retrieve an answer based on the provided query and sessionID.

Note: ngrok-link referes to https://ngrok link in the future.

Request

The request should include a JSON payload with the following parameters:

  • query (string): The user’s query.

  • sessionID (integer): The 10-digit session ID associated with the query.

Request Body Format (data)

json

{
"query": "example query",
"sessionID": 12334567890
}

The data needs to be stringify.

Response

Upon successful execution, the API will return a JSON response with the following structure:

  • answer (string): The response to the provided query.

  • status (string): The status of the response (“success” or “error”).

Example Response Format

Response Status

  • 200 OK: The request was successful and the response is available.

  • 404 Not Found: The requested resource could not be found.

Response Content-Type

  • application/json: The response content is in JSON format.


Example Request

Example Reponse

Last updated

Was this helpful?