Quick Start

Get up and running with the StudyHQ Partner API in minutes.

Prerequisites

Before you begin, make sure you have:

• A StudyHQ partner account (contact support@studyhq.com to get onboarded)
• Your TokenId and TokenSecret for your project
• Your projectId (provided during onboarding)

Step 1 — Generate an Assessment URL

After a student registers or completes payment on your platform, call the API to generate a unique assessment link.

$
curl -X POST https://api.studyhq.com/partner/get-redirect-url \
>
  -H "Content-Type: application/json" \
>
  -H "X-Access-Token: <TokenId>:<TokenSecret>" \
>
  -d '{
>
    "projectId": "L4ndb5PYxM",
>
    "name": "Student name",
>
    "email": "student@gmail.com",
>
    "mobile": "9876543210"
>
  }'

Response:

1
{
2
  "redirect-url": "https://app.studyhq.com/L4ndb5PYxM/assessment?token=eyJhbGciOiJSU..."
3
}

Open the redirect-url in a new tab for the student to begin the assessment.

Step 2 — Student Completes the Assessment

The student takes the assessment on StudyHQ. The test evaluates their aptitude, interests, and learning style. Upon completion, results are stored against their email address.

Assessment statuses:

Step 3 — Fetch Results

Once the student has completed the assessment, retrieve their results and course recommendations.

$
curl -X POST https://api.studyhq.com/partner/get-assessments-info \
>
  -H "Content-Type: application/json" \
>
  -H "X-Access-Token: <TokenId>:<TokenSecret>" \
>
  -d '{
>
    "projectId": "L4ndb5PYxM",
>
    "email": "student@gmail.com"
>
  }'

Response:

1
[
2
  {
3
    "AssessmentId": "AnE9YIqu5plq",
4
    "Status": "Completed",
5
    "Recommendations": [
6
      "Fashion Design",
7
      "Entrepreneurship & Family Business"
8
    ],
9
    "AssessmentDuration": "1m 58s"
10
  }
11
]

Use the Recommendations array to display personalised course options to the student on your platform.

What’s Next