README.md

---
title: Vulnerability Scanner Api
emoji: 🔒
colorFrom: blue
colorTo: red
sdk: docker
pinned: false
license: mit
---

# Vulnerability Scanner API

AI-powered security vulnerability scanner for GitHub repositories and files.

## Features

- 🔍 Single file vulnerability scanning
- 📦 Full repository scanning (up to 15 files)
- 🤖 Powered by Groq LLaMA 3.3 70B
- 🚀 Fast and accurate security analysis
- 📊 Detailed vulnerability reports with severity levels

## API Endpoints

### Health Check
```bash
GET /api/health
```

### Scan GitHub File or Repository
```bash
POST /api/scan
Content-Type: application/json

{
  "url": "https://github.com/owner/repo/blob/main/file.py"
}
```

Or scan entire repository:
```bash
{
  "url": "https://github.com/owner/repo"
}
```

## Environment Variables

- `GROQ_API_KEY` - Required for AI analysis
- `GITHUB_TOKEN` - Optional, for private repos and higher rate limits

## Usage

Test the API:
```bash
curl -X POST https://adityadevx-vulnerability-scanner-api.hf.space/api/scan \
  -H "Content-Type: application/json" \
  -d '{"url": "https://github.com/owner/repo/blob/main/file.py"}'
```

## Response Format

```json
{
  "result": "# Security Analysis Report\n\n## Vulnerabilities Found\n..."
}
```

Or in case of error:
```json
{
  "error": "Error message"
}
```