API Documentation
Quick Links
Chat InterfaceGitHub RepositoryHelp & Support
University Logo

API Documentation

University Chat Assistant

University Chat Assistant

Professional API Documentation

Comprehensive API documentation for the University Chat Assistant. Build powerful integrations with our AI-powered chat system, user management, analytics, and administrative tools.

18
Endpoints
7
Categories
100%
Coverage
3
Languages
Firebase Auth
University Only
RESTful API
Real-time
AI-Powered
Get StartedTry ChatAPI Debugger
Authentication Guide
Understanding Firebase authentication and university email requirements

Authentication Flow

  1. 1User signs in with Google using university email (@final.edu.tr)
  2. 2Firebase generates an ID token
  3. 3Include token in API requests: Authorization: Bearer <token>
  4. 4Backend verifies token and extracts user info

Email Requirements

  • Must end with @final.edu.tr
  • Must be verified in Firebase
  • Google Sign-In required
  • Academic institution verification
Base URL
https://final-academic-assistant.space

API Categories

Explore our comprehensive API endpoints organized by functionality

Health & System

3 endpoints

System health monitoring and status endpoints

View endpoints

Authentication

2 endpoints

Firebase authentication and user verification

View endpoints

User Management

5 endpoints

User registration, profiles, and account management

View endpoints

Chat & Messaging

4 endpoints

AI chat functionality, sessions, and real-time messaging

View endpoints

Notifications & Announcements

6 endpoints

System announcements and user notifications

View endpoints

Admin & Management

2 endpoints

Administrative functions, user management, and system control

View endpoints

Analytics & Monitoring

1 endpoints

System analytics, performance metrics, and monitoring tools

View endpoints

Health & System

System health monitoring and status endpoints

3 endpoints
Health Check
GET
Check if the API server is running and get basic system information
/api/health
system
health
monitoring
Method:
GET
Auth:Not Required
Full URL
GET https://final-academic-assistant.space/api/health
Detailed Health Check
GET
Get comprehensive system health information including database, Langflow, and system resources
/api/health/detailed
system
health
monitoring
database
langflow
Method:
GET
Auth:Not Required
Full URL
GET https://final-academic-assistant.space/api/health/detailed
Chat Service Health
GET
Check chat service health and Langflow configuration status
/api/chat/health
chat
health
langflow
ai
Method:
GET
Auth:Not Required
Full URL
GET https://final-academic-assistant.space/api/chat/health

Authentication

Firebase authentication and user verification

2 endpoints
Verify Authentication
GET
Auth
Verify Firebase authentication token and get current user information
/api/protected
auth
verification
user
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/protected
Register New User
POST
Auth
Register a new user with Firebase authentication and university email validation
/api/users/register
users
registration
auth
Method:
POST
Auth:Required
Rate Limit:5 requests per minute
Full URL
POST https://final-academic-assistant.space/api/users/register

User Management

User registration, profiles, and account management

5 endpoints
Register New User
POST
Auth
Register a new user with Firebase authentication and university email validation
/api/users/register
users
registration
auth
Method:
POST
Auth:Required
Rate Limit:5 requests per minute
Full URL
POST https://final-academic-assistant.space/api/users/register
Check Registration Status
POST
Auth
Check if a user needs registration and get Firebase user data for form pre-population
/api/users/registration-status
users
registration
status
Method:
POST
Auth:Required
Full URL
POST https://final-academic-assistant.space/api/users/registration-status
Get User Profile
GET
Auth
Get current authenticated user's profile information
/api/users/profile
users
profile
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/users/profile
Get User Announcements
GET
Auth
Get announcements relevant to the current user based on their role
/api/users/announcements
announcements
notifications
users
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/users/announcements
Mark Announcement as Read
POST
Auth
Mark a specific announcement as read by the current user
/api/users/announcements/{announcement_id}/read
announcements
notifications
users
Method:
POST
Auth:Required
Full URL
POST https://final-academic-assistant.space/api/users/announcements/{announcement_id}/read

Chat & Messaging

AI chat functionality, sessions, and real-time messaging

4 endpoints
Chat Service Health
GET
Check chat service health and Langflow configuration status
/api/chat/health
chat
health
langflow
ai
Method:
GET
Auth:Not Required
Full URL
GET https://final-academic-assistant.space/api/chat/health
Get Chat Sessions
GET
Auth
Get user's chat sessions with pagination, filtering, and sorting options
/api/chat/sessions
chat
sessions
pagination
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/chat/sessions
Send Chat Message
POST
Auth
Send a message to the AI assistant and receive a response
/api/chat/message
chat
ai
messages
Method:
POST
Auth:Required
Rate Limit:10 messages per minute
Full URL
POST https://final-academic-assistant.space/api/chat/message
Send Streaming Message
POST
Auth
Send a message with real-time streaming response
/api/chat/message/stream
chat
ai
streaming
real-time
Method:
POST
Auth:Required
Rate Limit:10 messages per minute
Full URL
POST https://final-academic-assistant.space/api/chat/message/stream

Notifications & Announcements

System announcements and user notifications

6 endpoints
Get User Announcements
GET
Auth
Get announcements relevant to the current user based on their role
/api/users/announcements
announcements
notifications
users
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/users/announcements
Mark Announcement as Read
POST
Auth
Mark a specific announcement as read by the current user
/api/users/announcements/{announcement_id}/read
announcements
notifications
users
Method:
POST
Auth:Required
Full URL
POST https://final-academic-assistant.space/api/users/announcements/{announcement_id}/read
Get All Announcements (Admin)
GET
Auth
Get all announcements for admin management with filtering options
/api/admin/announcements
admin
announcements
management
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/admin/announcements
Create Announcement (Admin)
POST
Auth
Create a new system announcement
/api/admin/announcements
admin
announcements
create
Method:
POST
Auth:Required
Full URL
POST https://final-academic-assistant.space/api/admin/announcements
Update Announcement (Admin)
PUT
Auth
Update an existing announcement
/api/admin/announcements/{announcement_id}
admin
announcements
update
Method:
PUT
Auth:Required
Full URL
PUT https://final-academic-assistant.space/api/admin/announcements/{announcement_id}
Delete Announcement (Admin)
DELETE
Auth
Delete an announcement permanently
/api/admin/announcements/{announcement_id}
admin
announcements
delete
Method:
DELETE
Auth:Required
Full URL
DELETE https://final-academic-assistant.space/api/admin/announcements/{announcement_id}

Admin & Management

Administrative functions, user management, and system control

2 endpoints
Get All Announcements (Admin)
GET
Auth
Get all announcements for admin management with filtering options
/api/admin/announcements
admin
announcements
management
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/admin/announcements
Get All Users (Admin)
GET
Auth
Get all users with filtering and pagination (admin only)
/api/admin/users
admin
users
management
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/admin/users

Analytics & Monitoring

System analytics, performance metrics, and monitoring tools

1 endpoints
Analytics Dashboard (Admin)
GET
Auth
Get comprehensive analytics dashboard data
/api/admin/analytics/dashboard
admin
analytics
dashboard
Method:
GET
Auth:Required
Full URL
GET https://final-academic-assistant.space/api/admin/analytics/dashboard
User Management
User registration, profile management, and account operations

User Registration

New users can register with their university email address. The system automatically validates the email domain and creates a user profile.

Profile Management

Users can view and update their profile information, including display name, preferences, and account settings.

Policy Search
Search and retrieve university policies and regulations

Policy Search

Search through university policies using keywords, categories, or specific criteria. Results include policy details, effective dates, and related documents.

Policy Documents

Access full policy documents, including PDFs, forms, and related resources for comprehensive policy information.

Testing & Debug
Testing endpoints and debugging tools for development

Langflow Testing

Test the connection to the Langflow AI service and verify that the AI integration is working properly.

Debug Tools

Access debugging tools and endpoints to troubleshoot issues, monitor system health, and verify API functionality.

Admin Endpoints
Administrative functions for system management

Cache Management

View cache statistics, clear cache entries, and manage system caching for optimal performance.

System Administration

Administrative tools for managing system settings, monitoring performance, and maintaining system health.

Analytics
System analytics, performance metrics, and usage statistics

Performance Metrics

Monitor system performance, response times, and resource utilization to ensure optimal operation.

Usage Statistics

Track API usage, user activity, and system analytics to understand usage patterns and optimize performance.

Database
Data storage, retrieval, and management

Data Storage

Secure storage of user sessions, chat messages, and user profiles with proper data management and backup.

Data Security

Encrypted data storage, secure access controls, and compliance with data protection regulations.

Configuration
System configuration and environment setup

Environment Variables

Configure system settings through environment variables for different deployment environments.

API Keys

Manage API keys, authentication tokens, and security credentials for external service integrations.

Performance
Performance optimization and monitoring

Optimization

Performance optimization techniques, caching strategies, and best practices for optimal API performance.

Monitoring

Real-time performance monitoring, alerting, and performance metrics tracking for system health.

Deployment
Deployment guides and production setup

Production Deployment

Step-by-step guide for deploying the application to production with proper security and performance configurations.

Docker & Cloud

Containerized deployment with Docker and cloud platform deployment options for scalability and reliability.

Examples
Code examples and integration tutorials

Code Examples

Complete code examples in JavaScript, Python, and cURL for integrating with the API and building applications.

Tutorials

Step-by-step tutorials for common use cases, authentication setup, and advanced integration patterns.

Ready to Get Started?
Everything you need to start building with the University Chat Assistant API

1. Check Health

Start by checking if the API is running and healthy

View Health Endpoints

2. Authenticate

Set up Firebase authentication with your university email

View Auth Endpoints

3. Start Chatting

Send your first message to the AI assistant

View Chat Endpoints
Try Live ChatAPI DebuggerAdmin Panel