Kleinkram

Appearance

API Documentation ​

For each entity, the API provides a named controller, thus all requests are grouped by entity. The API follows the RESTful API design principles.

Available Modules are:

  • project - Handles the authentication and authorization.
  • access - Handles access control.
  • user - Handles the user related requests.
  • auth - Handles the authentication and authorization.
  • mission - Handles the mission related requests.
  • tag - Shared for Metadata
  • file - Handles the file related requests.
  • topic - Handles the topic related requests.
  • action - Handles the action related requests.
  • queue - Handles the queue related requests.
  • category - Handles the category related requests.

WARNING

The API is not designed to be accessed directly, but rather through the Python package, CLI or via the frontend. If you want to access it directly, you need to pass a valid Cookie header and set the kleinkram-client-version header to the same version as the backend is running.

The latter allows us to display depreciation warnings for outdated client packages.

Example:

bash
curl 'http://localhost:3000/user/me' \
  -H 'Accept: application/json, text/plain, */*' \
  -H 'Kleinkram-Client-Version: 0.50.0' \
  -b 'authtoken=...; refreshtoken=...'