Documentation

Quick-start guide to get SIEM Copilot running and analyzing your first logs.

Getting Started

1. Start the Backend

cd backend
pip install -r requirements.txt
python -m uvicorn app.main:app --reload

2. Start the Frontend

cd frontend
npm install
npm run dev

3. Environment Variables

GROQ_API_KEY=your_groq_api_key
GOOGLE_API_KEY=your_google_api_key

Usage Guide

1

Upload Logs

Navigate to Upload Logs from the sidebar. Drag and drop your .log, .csv, .json, or .txt files. The system auto-detects the format and parses events.

2

View Dashboard

The Security Dashboard displays real-time metrics: total events, suspicious activity count, risk score with factor breakdown, severity distribution, top source IPs, and login trends.

3

Investigate via Chat

Use the Investigation Chat to ask natural language questions about your data. The AI has full context of your uploaded logs and detected threats.

4

Review Attack Timeline

The Attack Timeline groups events into distinct attack chains by threat actor IP. Each chain includes an AI-generated narrative and next-move prediction.

5

Generate Reports

Export comprehensive security reports with executive summaries, technical breakdowns, and recommended remediation steps.

API Endpoints

MethodEndpointDescription
POST/api/uploadUpload and parse a log file
GET/api/dashboardRetrieve dashboard metrics and risk score
POST/api/chatSend a natural language query to the AI
GET/api/timelineGet attack chains and event timeline
GET/api/reportGenerate a comprehensive security report
DELETE/api/clearClear all stored logs and reset the database