# Vacademy Docs

> Developer and admin docs for Vacademy: the Catalogue API for your own website, and the MCP server that lets Claude, ChatGPT and Cursor work with your institute's courses, learners and CRM.

- [Vacademy Catalogue API](https://docs.vacademy.io/introduction.md): List an institute's courses on its own website, link each one to its hosted course page, and send enquiries into its CRM.
- [Quickstart: Next.js App Router](https://docs.vacademy.io/quickstart.md): A server-rendered course grid, an optional course page with metadata and JSON-LD, and a sitemap.
- [Keys and websites](https://docs.vacademy.io/keys-and-websites.md): Publishable keys, verifying your domain, and which origins may call the API.
- [Courses](https://docs.vacademy.io/concepts/courses.md): Course ids, versions, languages, formats, prices and availability.
- [Streams and learning paths](https://docs.vacademy.io/concepts/streams-and-learning-paths.md): How the hosted catalogue groups courses, and how to render the same groups on your site.
- [Course pages and SEO](https://docs.vacademy.io/concepts/course-pages-and-seo.md): Hosted course URLs, seo metadata, schema.org structured data and sitemaps.
- [Send enquiries](https://docs.vacademy.io/guides/enquiries.md): Post a visitor's enquiry into the institute's CRM from a Next.js server action.
- [Going live](https://docs.vacademy.io/guides/going-live.md): A checklist before your site goes to production.
- [Errors](https://docs.vacademy.io/platform/errors.md): Every error has the same shape and a stable code.
- [Rate limits and caching](https://docs.vacademy.io/platform/rate-limits-and-caching.md): How many requests a key can make, and how fresh the data is.
- [Versioning](https://docs.vacademy.io/platform/versioning.md): What may change within v1, and what will not.
- [Changelog](https://docs.vacademy.io/platform/changelog.md): Changes to the Vacademy Catalogue API.
- [API reference](https://docs.vacademy.io/api-reference/introduction.md): Base URL, authentication and conventions.
- [Get site settings](https://docs.vacademy.io/api-reference/site/get-site-settings.md): The institute, where its course pages live, and the languages, formats, currency and price visibility of its catalogue. Use it to build filters.
- [List course pages for a sitemap](https://docs.vacademy.io/api-reference/site/list-course-pages-for-a-sitemap.md): Every published course with its hosted page and a `lastmod`. Courses without a page address are left out.
- [List courses](https://docs.vacademy.io/api-reference/courses/list-courses.md): The institute's published courses, one entry per course (language versions and levels are `variants`). Filters combine with AND. An unknown `stream` or `category` slug returns an empty page, not an error.
- [Get a course](https://docs.vacademy.io/api-reference/courses/get-a-course.md): Everything a course page needs: the summary fields plus descriptions, FAQs, preview video, authors, learning-path series, `seo` and schema.org `structured_data`. `id` may be the course id or the id of any of its language versions; the response `id` is always the course id.
- [Get a course outline](https://docs.vacademy.io/api-reference/courses/get-a-course-outline.md): Subject, module and chapter titles of each version (no content). Cached for 5 minutes. With `language`, only that language's versions (all versions if it has none).
- [List streams](https://docs.vacademy.io/api-reference/streams/list-streams.md): The streams (top-level subject areas) and their categories, as the hosted catalogue shows them, with course counts. Empty when the site has streams off.
- [List learning paths](https://docs.vacademy.io/api-reference/learning-paths/list-learning-paths.md): Ordered sequences of courses from the site's Learning Paths section. Empty when the site has none.
- [Get a learning path](https://docs.vacademy.io/api-reference/learning-paths/get-a-learning-path.md): The path and its steps, each a course summary. A step whose course is not published to the catalogue is still listed (from the path's own data: no subtitle, instructors or `created_at`).
- [Send an enquiry](https://docs.vacademy.io/api-reference/enquiries/send-an-enquiry.md): Saves an enquiry into the institute's CRM, exactly like the hosted catalogue's enquiry form. Call it from your server and pass the visitor's IP in `X-Client-IP`.
- [Introduction](https://docs.vacademy.io/mcp-server/introduction.md): Use your own AI app with your institute's courses, website, learners and leads. Each person signs in as themselves.
- [Quickstart](https://docs.vacademy.io/mcp-server/quickstart.md): Turn the server on, choose what AI apps can do and who can connect, then connect Claude and run your first prompts. About five minutes.
- [For counsellors](https://docs.vacademy.io/mcp-server/for-counsellors.md): What your AI app can see and do with your leads, in plain language.
- [How it works](https://docs.vacademy.io/mcp-server/how-it-works.md): How an AI app signs in, the three gates every request passes, and who the AI app acts as.
- [Claude (web, desktop and mobile)](https://docs.vacademy.io/mcp-server/connect/claude.md): Add your institute as a custom connector in Claude, sign in on your admin portal, and choose which tools Claude may use.
- [Claude Code](https://docs.vacademy.io/mcp-server/connect/claude-code.md): Add your institute's server to Claude Code with one command, then sign in from the /mcp menu.
- [ChatGPT](https://docs.vacademy.io/mcp-server/connect/chatgpt.md): Add your institute's server to ChatGPT as a custom MCP server, then sign in on your admin portal.
- [Cursor](https://docs.vacademy.io/mcp-server/connect/cursor.md): Add your institute's server to Cursor's mcp.json, sign in on your admin portal, and use the tools from the Agent.
- [VS Code (GitHub Copilot)](https://docs.vacademy.io/mcp-server/connect/vscode.md): Add your institute's server to VS Code's mcp.json and use the tools from Copilot chat.
- [Other apps and custom clients](https://docs.vacademy.io/mcp-server/connect/other-apps.md): Connect any MCP app that supports remote servers with OAuth sign-in, create a client ID for apps that need one, and debug with MCP Inspector.
- [Turn on the MCP server](https://docs.vacademy.io/mcp-server/settings/enable-the-server.md): Switch the server on for your institute, choose what AI apps may do, and share the server URL with your team.
- [Who can connect](https://docs.vacademy.io/mcp-server/settings/roles.md): Choose which staff roles may connect an AI app, and give some roles more access than others.
- [Areas and access levels](https://docs.vacademy.io/mcp-server/settings/areas-and-levels.md): Set each area to Off, View or Edit, and see exactly what each level lets an AI app do.
- [Risk levels](https://docs.vacademy.io/mcp-server/settings/risk-levels.md): What each badge on a change means for your learners, leads and website visitors, and which changes are turned on separately.
- [Edits turned on separately](https://docs.vacademy.io/mcp-server/settings/opt-in-features.md): The changes no preset or level ever switches on for you, and why.
- [Connections and revoking](https://docs.vacademy.io/mcp-server/settings/connections-and-revoking.md): See which AI apps are connected to your institute, who connected them, and how to cut access.
- [Client IDs](https://docs.vacademy.io/mcp-server/settings/client-ids.md): Your institute's client ID, when an AI app needs one, and how to add a client ID for another app.
- [Previews and confirmations](https://docs.vacademy.io/mcp-server/usage/confirmations.md): How live changes work: the AI app shows you a preview, you say yes in the chat, and only then does anything happen.
- [Drafts vs live](https://docs.vacademy.io/mcp-server/usage/drafts-vs-live.md): Which AI changes are saved as drafts for a person to publish, and which reach learners, visitors or leads straight away.
- [Prompting tips](https://docs.vacademy.io/mcp-server/usage/prompting-tips.md): How to ask so the AI app picks the right tool, finds the right record and checks with you before it changes anything.
- [Playbooks](https://docs.vacademy.io/mcp-server/usage/playbooks.md): Copy-paste prompts for admins, counsellors, sales managers and owners, with what to expect from each.
- [Errors](https://docs.vacademy.io/mcp-server/usage/errors.md): The error codes the tools return, what each one means and what to do about it.
- [Troubleshooting](https://docs.vacademy.io/mcp-server/usage/troubleshooting.md): Fixes for the common problems: can't connect, refused at sign-in, missing tools, the wrong institute, client ID prompts and expired sessions.
- [How sign-in works](https://docs.vacademy.io/mcp-server/oauth/how-sign-in-works.md): What happens between pasting the server URL and the AI app using its first tool.
- [Your institute's server URL](https://docs.vacademy.io/mcp-server/oauth/institute-server-url.md): Why the server URL names your institute, where to find it, and what to do with more than one institute.
- [Tokens and expiry](https://docs.vacademy.io/mcp-server/oauth/tokens-and-expiry.md): How long a connection lasts, how it renews itself, and what ends it.
- [Tool catalogue](https://docs.vacademy.io/mcp-server/tools/catalogue.md): Every area an admin can switch on, and where to find the full reference for its tools.
- [Who is connected](https://docs.vacademy.io/mcp-server/tools/identity.md): Name, contact details and the institute's branding.
- [Institute stats](https://docs.vacademy.io/mcp-server/tools/institute.md): Profile, outstanding fees, live classes, learner counts.
- [Website](https://docs.vacademy.io/mcp-server/tools/website.md): Pages, sections, theme, SEO and site traffic.
- [Lead forms](https://docs.vacademy.io/mcp-server/tools/lead-forms.md): Lead campaigns, their form fields and leads received.
- [Automations](https://docs.vacademy.io/mcp-server/tools/automations.md): Workflows, their runs, and email / WhatsApp templates.
- [Blog](https://docs.vacademy.io/mcp-server/tools/blog.md): Blog posts and the pages that show them.
- [Courses](https://docs.vacademy.io/mcp-server/tools/courses.md): Course content, drip rules, invite links and pricing.
- [Learners](https://docs.vacademy.io/mcp-server/tools/learners.md): Find learners, enrol them into courses and edit their details.
- [Progress reports](https://docs.vacademy.io/mcp-server/tools/learner-reports.md): A learner's attendance, scores, study time and progress, for the AI app to write their report.
- [CRM: Leads](https://docs.vacademy.io/mcp-server/tools/crm-leads.md): Find and work leads: details, follow-ups, status, owners and new enquiries.
- [CRM: Calls](https://docs.vacademy.io/mcp-server/tools/crm-calls.md): Calls, transcripts and callbacks; calling leads and AI campaigns.
- [CRM: Meetings](https://docs.vacademy.io/mcp-server/tools/crm-meetings.md): Counselling meetings, free slots and booking pages.
- [CRM: Messages](https://docs.vacademy.io/mcp-server/tools/crm-messages.md): Lead WhatsApp and email history, inbox and templates.
- [CRM: Reports](https://docs.vacademy.io/mcp-server/tools/crm-reports.md): Sources, funnel, counsellors, calling, follow-ups and SLAs.
- [Security overview](https://docs.vacademy.io/mcp-server/security/overview.md): The checks every request passes before an AI app can see or change anything in your institute.
- [Data and privacy](https://docs.vacademy.io/mcp-server/security/data-and-pii.md): What institute data reaches the AI app, how contact details are limited, and whose data policy applies.
- [Audit log](https://docs.vacademy.io/mcp-server/security/audit-log.md): What the server records for each tool call, what it leaves out, and how admins see who is connected.
- [Prompt injection](https://docs.vacademy.io/mcp-server/security/prompt-injection.md): Text written by leads and visitors is returned as data, and changes that matter wait for your yes.
- [Guardrails](https://docs.vacademy.io/mcp-server/security/guardrails.md): The safety limits built into the MCP server, from per-request checks to single-use confirmations.
- [Changelog](https://docs.vacademy.io/mcp-server/changelog.md): What changed in Vacademy MCP, newest first.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.