Notapex Developer & AI Agent Platform

Notapex Public REST API v1, MCP Server & OAuth 2.0 Documentation

Programmatic access for AI agents, LLM tool-calling clients, and developers to search verified academic & competitive exam study notes, read structured transcripts, check pricing plans, and convert handwritten notebooks into clean PDFs or PowerPoint decks.

OpenAPI 3.1 JSON (/openapi.json)OpenAPI 3.1 YAML (/api/openapi.yaml)MCP Server (/mcp)Agent Auth Guide (/auth.md)

1. Machine-Readable Discovery Surfaces

ResourceCanonical EndpointStandard / Format
OpenAPI 3.1 Specification (JSON)https://notapex.com/openapi.jsonOpenAPI 3.1.0
OpenAPI 3.1 Specification (YAML)https://notapex.com/api/openapi.yamlOpenAPI 3.1.0 YAML
API Cataloghttps://notapex.com/.well-known/api-catalogRFC 9727 Linkset
MCP Server (Streamable HTTP)https://notapex.com/mcpMCP 2025-03-26
MCP Server Cardhttps://notapex.com/.well-known/mcp/server-card.jsonMCP Discovery Card
OAuth 2.0 Authorization Server Metadatahttps://notapex.com/.well-known/oauth-authorization-serverRFC 8414 + PKCE S256
OAuth 2.0 Protected Resource Metadatahttps://notapex.com/.well-known/oauth-protected-resourceRFC 9728
Agent Authentication Walkthroughhttps://notapex.com/auth.mdWorkOS auth.md

2. Public REST API v1 Endpoints

Base URL: https://notapex.com/api/v1 (Sandbox: https://notapex.com/api/sandbox)

  • GET /api/v1 — Service health, supported OAuth scopes, and API discovery links.
  • GET /api/v1/notes?q=&category=&limit=20&cursor= — Search and list verified study notes with cursor pagination (notes:read or public).
  • GET /api/v1/notes/{slug} — Retrieve detailed note metadata, page count, pricing in INR, and structured transcript summary.
  • GET /api/v1/categories — List all supported academic categories and competitive exam tracks (JEE, NEET, UPSC, SSC, GATE, Computer Science).
  • POST /api/v1/conversions — Submit an asynchronous AI Note Converter or Presentation Maker job (202 Accepted, supports Idempotency-Key and X-Sandbox-Mode: true).
  • GET /api/v1/jobs/{jobId} — Poll status (queued, processing, completed) of an asynchronous conversion job.
  • POST /api/v1/batch — Bulk lookup up to 50 study note slugs in a single HTTP request.
  • GET /api/v1/pricing — Retrieve structured pricing tiers and credit packages in INR.

3. OAuth 2.0 Authentication & Scoped Permissions

Notapex implements OAuth 2.0 with PKCE (S256), RFC 7591 Dynamic Client Registration (POST /api/oauth/register), and granular least-privilege scopes declared in both /openapi.json and /.well-known/oauth-protected-resource:

notes:read

Read published study notes, metadata, summaries, transcripts, and academic categories.

notes:write

Create, update, and upload study notes, attachments, and study bundles.

notes:convert

Submit handwritten notes or documents for AI OCR transcription, PDF formatting, and PPTX generation.

channels:read

Browse creator channels, verified educators, and curated exam collections.

account:read

Read authenticated user profile, subscription plan, and AI credit balance.

webhooks:manage

Register and manage webhook endpoints for asynchronous conversion job notifications.

4. Model Context Protocol (MCP) Server

Connect Claude, ChatGPT, Cursor, or any MCP client directly to https://notapex.com/mcp using Streamable HTTP transport (and https://notapex.com/mcp/docs for documentation search). Exposed tools include search_notes, get_note, list_categories, create_note_conversion, get_conversion_status, get_pricing_plans, and search_docs.

5. API Versioning, Rate Limits & Deprecation Policy

All API responses carry RFC standard RateLimit-Limit, RateLimit-Remaining, and RateLimit-Reset headers. Breaking changes are introduced only in new major versions (/api/v2) with a minimum 365-day deprecation window and Sunset + Deprecation headers.

← Return to Notapex Homepage