Skip to content

ashrafee-dev/scamshield_api

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ScamShield API

A FastAPI-powered API for analyzing scam emails and scam using local transcription and AI-based risk assessment.

Features

Risk Assesment for:

  • Email scam analysis
  • Audio file scam analysis (e.g. recorded call)
  • Real-time audio analysis over WebSockets (e.g. live call)

Project Structure

app/
├── api/          # HTTP & WebSocket routes
├── models/       # Request and response models
├── services/     # AI, transcription, audio processing
├── config.py
└── main.py

tests/

Getting Started

  • Get your .env configured (look at example.env)
uv sync
uv run --env-file .env fastapi dev app/main.py

Contributing

Contributions are welcome.

  • Keep the code simple and readable.

  • NOAI contributions are preferred.

  • For First Time Contribution

    • Look for issues labeled first-time-contribution. I'll keep them small and beginner-friendly so anyone can make their first contribution.
  • Have fun!

About

A scam detection service built with FastAPI. docs - https://scamshield-api-fhes.vercel.app/

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages