VoxWise MediaVoxWiseMedia
API Docs

Build on the VoxWise API

A REST API covering every product on the platform. Explore it interactively or start with the basics below.

Base URL

All endpoints are served under the /api/v1 prefix, for example https://api.voxwise.media/api/v1/courses. In local development the API runs at http://localhost:4000/api/v1.

Interactive docs

A live, auto-generated Swagger/OpenAPI UI is available at /api/docs on the API host (locally: http://localhost:4000/api/docs). It lists every route, schema, and lets you try requests.

Authentication

Most write endpoints require a bearer token. Obtain one from POST /auth/login (returns accessToken) and send it as:

  • Authorization: Bearer <accessToken>

Public catalog reads (courses, creators, products, OTT) need no token.

Endpoint groups

  • Auth — register, login, email verify, password reset, profile
  • Courses — catalog, sections/lessons, enroll, progress, quizzes, certificates
  • Creators — profiles, directory, follow
  • Products — marketplace listings, purchase-gated downloads
  • Payments — orders, Stripe, crypto, mobile money, referrals
  • Events — listings, tickets, streaming, classroom (WebRTC), polls, check-in
  • Notifications — in-app list, unread, mark-read
  • AI — outline, quiz, tutor, assistant, translate, recommend, analytics
  • Talent — profiles, ranking, brand matching, deals, contracts
  • OTT — catalog, plans, subscription, playback, recommendations

Conventions

  • JSON request and response bodies.
  • List endpoints are paginated: { items, total, page, limit, totalPages }.
  • Standard HTTP status codes; errors return a message payload.

Need help integrating? Visit the Help Center or contact us.

API Docs · VoxWise