API Reference
Complete documentation for the ScamShield REST API. All endpoints support JSON.
Base URL
https://scamshield-honeypot.onrender.com/api/v1Format
JSONQuick Start
curl -X POST https://scamshield-honeypot.onrender.com/api/v1/honeypot/engage \
-H "Content-Type: application/json" \
-d '{
"scammer_message": "Dear Customer, your KYC is pending...",
"persona": "elderly_victim"
}'Honeypot
Core scam engagement endpoints
/api/v1/honeypot/engageEngage Scammer
Start a new honeypot session by processing an initial scammer message. The AI will analyze the message, detect the scam type, select an appropriate persona, and generate a realistic victim response.
/api/v1/honeypot/continueContinue Conversation
Continue an existing session by sending the next scammer message. The AI maintains conversation context and continues extracting intelligence.
/api/v1/honeypot/session/{session_id}Get Session Details
Retrieve complete details of a specific session including all messages and extracted intelligence.
/api/v1/honeypot/session/{session_id}Delete Session
Delete a specific session and all associated data.
Sessions
Session management and history
/api/v1/sessionsList All Sessions
Retrieve all sessions with optional filtering and pagination.
/api/v1/sessions/{session_id}/intelligenceGet Session Intelligence
Retrieve all extracted intelligence for a specific session.
Intelligence
Extracted entity management
/api/v1/intelligenceList All Intelligence
Retrieve all extracted entities across all sessions.
Analytics
Statistics and reporting
/api/v1/analytics/summaryAnalytics Summary
Get aggregated analytics including session counts, entity stats, and scam type distribution.
/api/v1/analytics/scam-typesScam Type Distribution
Get distribution of detected scam types.
/api/v1/analytics/timelineActivity Timeline
Get session activity over time for charting.
Health
System health monitoring
/api/v1/healthHealth Check
Basic health check endpoint.
/api/v1/health/detailedDetailed Health Check
Detailed health check with component statuses.