# StudyHQ | Documentation

## Instructions for AI Agents

- For clean Markdown of any page, append `.md` to the page URL
- For section-specific indexes, append `/llms.txt` to any section URL
- For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.studyhq.com/_mcp/server

## Docs

- [Introduction](https://docs.studyhq.com/documentation/introduction.md): StudyHQ helps students discover the right path through a career-fit assessment — run an admissions funnel or a full guidance programme in the StudyHQ Portal, or generate assessment links from your own system via the API.
- [Institution Flow — Overview](https://docs.studyhq.com/documentation/institution/overview.md): How an institution runs StudyHQ's assessment funnel — from inviting students to delivering career reports.
- [Getting started](https://docs.studyhq.com/documentation/institution/portal-guide-team/getting-started.md): Sign in to the StudyHQ Portal, find your way around the Organisations page, and create an institution and an assessment-funnel project.
- [Organisation settings, team & billing](https://docs.studyhq.com/documentation/institution/portal-guide-team/organisation-settings-team-billing.md): Manage your institution's branding, invite your team with per-project roles, and manage your plan and assessment credits.
- [Project settings](https://docs.studyhq.com/documentation/institution/portal-guide-team/project-settings.md): Configure a funnel project — identity, assessment time limit and report options, the student form & profile, the workflow pane, and the mapped courses or streams.
- [Dashboard](https://docs.studyhq.com/documentation/institution/portal-guide-team/dashboard.md): Read your funnel at a glance — date-filtered registration, assessment and enrolment numbers, trend charts, and the recommendations mix.
- [Students](https://docs.studyhq.com/documentation/institution/portal-guide-team/students.md): Add students to the funnel, send assessment links, filter and search the roster, and manage each student's profile, assessments, and enrolment.
- [Cases](https://docs.studyhq.com/documentation/institution/portal-guide-team/cases.md): The case view — every student's funnel record in one list, filterable by enrolment outcome, with quick access to each student's detail.
- [Signing in](https://docs.studyhq.com/documentation/institution/student-guide/signing-in.md): How a student enters Bixa, the StudyHQ student app, in the institution flow — straight from the institution's assessment link, or by signing in with an email code.
- [Your dashboard](https://docs.studyhq.com/documentation/institution/student-guide/your-dashboard.md): The student dashboard — a simple three-step journey from setting up your profile to taking your assessment and viewing your report.
- [Taking the assessment](https://docs.studyhq.com/documentation/institution/student-guide/taking-the-assessment.md): What to expect during the StudyHQ career-fit assessment — the start screen and timer, the sections and questions, pausing and resuming, and auto-submit.
- [Your career report](https://docs.studyhq.com/documentation/institution/student-guide/your-career-report.md): How to read your StudyHQ career report — your cognitive and behavioural strengths, your best-fit courses or streams, and the careers each path leads to.
- [Agency Flow — Overview](https://docs.studyhq.com/documentation/agency/overview.md): How an agency — a school guiding its own students, or a counselling agency serving external students — runs StudyHQ's Career Guidance journey, from intake to a locked career plan.
- [Getting started](https://docs.studyhq.com/documentation/agency/portal-guide-team/getting-started.md): Sign in to the StudyHQ Portal, choose your organisation and project, and learn what each role sees — plus the notices that appear before a plan is active.
- [Organisation & team](https://docs.studyhq.com/documentation/agency/portal-guide-team/organisation-team.md): The organisation-level pages — your projects, organisation settings, inviting your team and managing their roles, and your own account.
- [Billing, plans & credits](https://docs.studyhq.com/documentation/agency/portal-guide-team/billing-plans-credits.md): Choose and change plans, top up credits, understand what each activity costs, read your credit history, and download invoices.
- [Project settings](https://docs.studyhq.com/documentation/agency/portal-guide-team/project-settings.md): The three settings panes — General (identity, boards, assessment settings), Workflow (phases, session names & length), and Intake & Profile (the student form grid).
- [Dashboard](https://docs.studyhq.com/documentation/agency/portal-guide-team/dashboard.md): The admin project overview — date-filtered cards, cohort stages, assessment trends, report results, and counselling delivery — plus the counsellor's personal dashboard.
- [Students](https://docs.studyhq.com/documentation/agency/portal-guide-team/students.md): The project roster — add students one by one or import a spreadsheet, send login links, and work each student's profile page.
- [Cases](https://docs.studyhq.com/documentation/agency/portal-guide-team/cases.md): Every student journey in one list — filter, export, and distribute the caseload by assigning counsellors.
- [Sessions & counselling](https://docs.studyhq.com/documentation/agency/portal-guide-team/sessions-counselling.md): The counselling calendar — set availability, book sessions, run them over video, mark outcomes, and (on advanced plans) get AI summaries and transcripts.
- [Career plans & roadmaps](https://docs.studyhq.com/documentation/agency/portal-guide-team/career-plans-roadmaps.md): The counsellor's working surface on the Overview tab — directions, SWOT, action items, locking the career plan, and the roadmap the student receives.
- [Working as a member or counsellor](https://docs.studyhq.com/documentation/agency/portal-guide-team/working-as-a-member-or-counsellor.md): The day-to-day guide for the two everyday team roles — what members and counsellors each see, do, and hand over to admins.
- [Logging in](https://docs.studyhq.com/documentation/agency/student-guide/logging-in.md): How a student enters Bixa, the StudyHQ student app — the invitation email, the passwordless email-code login, and completing your details the first time.
- [Your dashboard & questionnaire](https://docs.studyhq.com/documentation/agency/student-guide/your-dashboard-questionnaire.md): Your home page — the journey overview and next-step card — and the need-analysis questionnaire for you (and, in some programmes, your parent).
- [Taking the assessment](https://docs.studyhq.com/documentation/agency/student-guide/taking-the-assessment.md): The timed assessment — the intro screen, the timer and autosave, and the review panel that makes sure nothing is left blank before you submit.
- [Your career report](https://docs.studyhq.com/documentation/agency/student-guide/your-career-report.md): Your assessment results — stream or course recommendations with fit scores, the reasoning behind them, and the PDF download.
- [Sessions & your roadmap](https://docs.studyhq.com/documentation/agency/student-guide/sessions-your-roadmap.md): Book your own counselling sessions, join the calls, and follow the roadmap your counsellor locks in with you — plus your profile and common questions.
- [Quick Start](https://docs.studyhq.com/documentation/integration-guide/quick-start.md): Integrate StudyHQ assessments in three steps — authenticate, generate a student's assessment link, and fetch their results.
- [Partner Workflow](https://docs.studyhq.com/documentation/integration-guide/partner-workflow.md): End-to-end integration flow for embedding StudyHQ assessments into your platform.
- [Enrollment Sync](https://docs.studyhq.com/documentation/integration-guide/enrollment-sync.md): Keep StudyHQ updated when a student converts to an enrolled admission on your platform.

## API Docs

- API Reference > Partner [Generate Assessment Redirect URL](https://docs.studyhq.com/api-reference/api-reference/partner/generate-redirect-url.md)
- API Reference > Partner [Get Assessments Info](https://docs.studyhq.com/api-reference/api-reference/partner/get-assessments-info.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://docs.studyhq.com/openapi.json)
- [OpenAPI YAML](https://docs.studyhq.com/openapi.yaml)