Skip to main content

MirrorMingo Developer Platform — Documentation

The MirrorMingo Exam API gives any app verified African exam content (JAMB, WAEC, NECO, IELTS, SAT and more) and a timed mock-exam engine — the same content that powers MirrorMingo, never AI-fabricated.

Contents

  1. Quickstart — your first request in 5 minutes
  2. Authentication — API keys and security
  3. Integration guide — build an end-to-end mock-exam flow
  4. Webhooks — receive scored-attempt and content-update events
  5. Rate limits & errors — quotas and error handling
  6. SDKs — TypeScript, Python, Java, PHP, Go, Dart
  7. MCP server — use MirrorMingo from AI agents
  8. API reference — generated from the OpenAPI spec

Publishing the reference site

The human-readable reference is rendered from sdks/openapi/mirrormingo.openapi.yaml. We use Redocly for a zero-config static site:

cd sdks
npm install
npx @redocly/cli build-docs openapi/mirrormingo.openapi.yaml -o ../docs/developers/reference.html

Host docs/developers/ behind developers.mirrormingo.com. The markdown guides render as-is in any static-site generator (Mintlify, Nextra, Docusaurus); we recommend Mintlify for the smallest setup.