API Documentation

REST API reference for Flux

POST/scan

Submit a binary file for analysis. The pipeline runs YARA matching, CatBoost classification, and LightGBM scoring in sequence. Supports both synchronous JSON responses and streaming SSE mode for real-time verdict delivery.

Request

Content-Type: multipart/form-data

curl -X POST https://5r4v4n-Flux.hf.space/scan \
  -F "file=@sample.exe" \
  -F "stream=false"

Response

{
  "sha256": "e3b0c44298fc1c149afb...",
  "verdict": "malicious",
  "confidence": 0.94,
  "vibe": "packed-dropper",
  "layers": {
    "yara": { "matched": ["vibeware.yar:rule_packed_pe"], "score": 1 },
    "catboost": { "score": 0.91 },
    "lightgbm": { "score": 0.97 }
  },
  "scan_time_ms": 412
}