FAQ'S

How to integrate pre build result page to my platform ?

📄 Result Content Format

When fetching result content via the API, you have two format options:

1. JSON Format (Default)

Returns structured data in JSON format.
Perfect for custom UI rendering using your own technologies and design system.
You have full control over how the results are displayed.

2. HTML Format (Tailwind CSS Styled)

Returns ready-to-render HTML content already styled with Tailwind CSS.
Great for quick integrations without needing to write additional markup or styles.
Important: You must include tailwindcss in your frontend platform to render this properly.
Make sure your frontend allows safely rendering HTML (e.g., dangerouslySetInnerHTML in React).

Example Use Case

Use JSON if you want to build a fully custom experience.
Use HTML if you prefer a quick and styled output with minimal integration effort.

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>Document</title>
    <script src="https://cdn.jsdelivr.net/npm/@tailwindcss/browser@4"></script>

</head>
<body>
    <div id="embed_result"></div>
</body>
<script>
    const data=""
    document.getElementById("embed_result").innerHTML=data
</script>
</html>

📘 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

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