📘 Bhavishyayaan API Documentation

The Bhavishyayaan APIs are structured around REST principles, making them easy to integrate and use with standard HTTP methods. These APIs are backed by a robust software layer that connects and optimizes global communication networks.With Bhavishyayaan, developers can build powerful applications that analyze user psychology and mental state by leveraging our intelligent data interpretation systems. Whether you're developing tools for mental health, behavioral analysis, or personalized user experiences, our APIs provide the insights and infrastructure needed to support your innovation.

🛡️Bhavishyayaan Api Authentication

To Autheticate requests to the Bhavishyaan Apis. Bhavishyaan support 'KEY' Based authentication. You can use the follewing credentials.

Note: All API requests must include a valid API key in the request header. You will receive your unique API key from our team.

Header Format:X-API-KEY: <YOUR_API_KEY>

Note: Do not share your API key publicly. Treat it like a password!

Endpoints Overview

Test Categroies List

GET /test/categories/list/ - List all available test Category

example:

let config = {
 method: 'get',
 maxBodyLength: Infinity,
 url: ‘url_domain’,
 headers: {
   'X-API-KEY': '••••••'
 }
};


axios.request(config)
.then((response) => {
// your logic here
 })
.catch((error) => {
 console.log(error);
});

Test List

GET /test/list/?test={category_id} - Get list of all tests in a category

example:

let config = {
 method: 'get',
 maxBodyLength: Infinity,
 url: 'url_domain',
 headers: {
   'X-API-KEY': '••••••'
 }
};


axios.request(config)
.then((response) => {
// your logic here
}).catch((error) => {
 console.log(error);
});

Test Questions

GET /test/questions/{test_id} - get test questions

example:

let config = {
 method: 'get',
 maxBodyLength: Infinity,
 url: ‘url_domain’,
 headers: {
   'X-API-KEY': '••••••'
 }
};


axios.request(config)
.then((response) => {
 	// your logic here
})
.catch((error) => {
 console.log(error);
});

Submit Test

POST /test/submit/{test_id}/ - Submit user response

example:

let data = JSON.stringify({
 "uid": "a unique userId", // use a unique user id for a specific user and use that user id for all the submission
  done by a user. This is important to generate the final report
 "user_name": "name of user who is submitting the test for user result pdf(Optional)",
 "user_email": "email of user who is submitting the test for user result pdf(Optional)",
 "user_class": "class of student(if any)(Optional)",
 "category":”test_category_id”,


// Note: if test is of type ‘MCQ’ then use:
 "response": [
   {
     "question":question_id,
     "selected_options": [
       selected_option_id
     ]
   },
   {
     "question": question_id,
     "selected_options": [
       selected_option_id
     ]
   }
 ]


// Note: if test is of type ‘Multiselect’ then use:
"response": [
	{
     "question": question_id,
     "selected_options": [
       selected_option_id,
       selected_option_id,
       selected_option_id
     ]
}
]
});

let config = {
 method: 'post',
 maxBodyLength: Infinity,
 url: 'url_domain',
 headers: {
   'Content-Type': 'application/json',
   'X-API-KEY': '••••••'
 },
 data : data
};


axios.request(config)
.then((response) => {
 // your logic here
})
.catch((error) => {
 console.log(error);
});