API Documentation

🚀 Interactive API Documentation

The Bachelor Thesis Chatbot API provides comprehensive documentation through FastAPI's automatic documentation generation. Choose your preferred documentation interface:

Checking API status...
📖 Swagger UI Documentation 📋 ReDoc Documentation

📊 API Overview

API Title: Bachelor Thesis Chatbot API

Version: 1.0.0

Base URL: http://localhost:8000

Description: Backend API for user management, chat processing, skill extraction, and data visualization.

🔗 Key Endpoints Preview

Here are some of the main API endpoints available:

POST/api/users/register
Register a new user account
POST/api/users/login
Authenticate user credentials
GET/api/users/{user_id}
Get user information by ID
POST/api/users/{user_id}/sessions
Create a new chat session
GET/api/sessions/{session_id}/messages
Get all messages from a chat session
POST/api/users/{user_id}/chat
Send a message to the chatbot
GET/ws
WebSocket endpoint for real-time messaging

🛠️ Getting Started

To explore the API documentation:

  1. Ensure the backend server is running: uv run python app.py
  2. Click on one of the documentation links above
  3. Use the interactive interface to test API endpoints
  4. View request/response schemas and examples

📝 Notes

  • Swagger UI provides an interactive testing interface
  • ReDoc offers a clean, readable documentation format
  • Both interfaces show the same API information in different formats
  • All endpoints include detailed schemas and examples

🔧 Development Tools

Additional development resources:

  • OpenAPI Schema: API Schema
  • Health Check: Available through the API endpoints
  • WebSocket Testing: Use the Chat Demo page for real-time testing