Bhavisyanyaan LogoMahalearningtab Logo

BHAVISHYAYAAN

A Mindful Insight Into Your Future

Menu

šŸ“˜ 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.

šŸ” API Flow

This interactive flowchart below outlines the primary sequence of API calls for taking a test. Click on any node to view detailed information about that step in the process.

šŸ›”ļø Bhavishyayaan API Authentication


To authenticate requests to the Bhavishyayaan APIs, we support 'KEY'-based authentication. You will receive your unique API key from our team.

Note: All API requests must include a valid API key in the request header. Do not share your key publicly!

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

Endpoints Overview

Test Categories 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

Query (Object)


  • category_id

    you can get the 'category_id' using above endpoint

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}/{category_id} - get test questions

Query (Object)


  • category_id

    To get the 'category_id', use the first endpoint

  • test_id

    To get the 'test_id', use the second endpoint

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

Query (Object)


  • test_id

    To get the 'test_id', use the second endpoint

Body (Object)

  • uid

    (Optional)

    uid is the userId of the user submitted the test.

  • user_name

    (Optional)

    name of the user submitting the test (used in pdf)

  • resultType

    (Optional)

    response you want i.e. JSON/HTML

  • user_email

    (Optional)

    email of the user who is submitting the test (used in pdf)

  • user_class

    (Optional)

    class of student (if any)

  • category

    category of test submitted by user

  • response

    contains list of user submission data

example:

hi