API

Overview of the public API and real-time endpoints used by IDK.

REST endpoints

Base path: added under the project URL configuration, see idk/api/urls.py.

Examples in idk/api/urls.py:

  • push-register/: Push device registration
  • slack/: Slack URL verification
  • slack-events/: Slack event ingestion
  • company/: Company listing
  • <uuid>/delete-reports/: Delete company reports by UUID
  • get-task-status/: Query background task status

WebSocket endpoints

Defined in idk/api/routing.py:

  • ws/running/: Running status stream (ASGI consumer)

Versioning and auth

  • Authentication: Django session auth for internal use; extend with tokens as needed
  • Versioning: Not currently versioned; consider prefixing with /api/v1/ for external exposure

Next steps

  • Add request/response schemas per endpoint
  • Document authentication in more detail

Interactive API Documentation