API Reference

The ZəkaHouse API is a RESTful service built with FastAPI. It powers all platform operations, from user authentication to course management and AI features. All endpoints are prefixed with /api/v1/.

Full API Reference

Base URL

In local development, the API is available at:

http://localhost:1338/api/v1/

On the hosted ZəkaHouse deployment, the API is served at https://learn.zekalab.info/api/v1/, with each organization addressed on its own subdomain (https://<org>.learn.zekalab.info/). Self-hosted production instances serve it behind a reverse proxy under /api/v1/ on their own domain.

Response Format

All API responses are returned as JSON. Successful responses typically include the requested data directly, while error responses follow this structure:

{
  "detail": "Description of the error"
}

Sections

• Full API Reference — Every endpoint, schema, code example and playground.
• Authentication — How to obtain and use authentication tokens.
• Endpoints — Overview of the key API endpoint groups.

OpenAPI Specification

Since the API is built with FastAPI, a machine-readable OpenAPI specification is served at /openapi.json relative to wherever the API process itself is reached — in local development that’s http://localhost:1338/openapi.json . Use it to generate client libraries or import the API into testing tools. (The interactive Swagger UI at /docs is only enabled on development instances.)

Note: The full API Reference is the reliable source for the live schema on the hosted deployment — the exact public path for the raw openapi.json behind the reverse proxy hasn’t been confirmed and may need adjusting here once verified.