API Documentation

Comprehensive guides and API references for integrating AntiBait's email threat detection into your applications.

Full AI Analysis

Premium

Advanced AI-powered analysis providing comprehensive threat intelligence and risk assessment.

API Endpoint

POST
POST/api/analysis/advanced

Request Body

{
  "email": "string 
  (full raw email)"
}

Max 1MB. Must include headers and body.

Response

{
  "status": 200,
  "success": true,
  "analysisId": "uuid",
  "cached": false,
  "score": number,
  "headerScore": number | null,
  "bodyScore": number | null,
  "threatType": string | null,
  "type": string | null,
  "confidence": number | null,
  "tags": string[],
  "reasoning": string | null,
  "falsePositiveChecks": string[],
  "error": string | null,
  "data": object
}

Analysis Features

AI-Powered Detection

Advanced machine learning models for accurate threat identification

Comprehensive Scoring

Multi-dimensional risk assessment with confidence metrics

Threat Categorization

Detailed tags and threat type classification

Detailed Reasoning

Explainable AI with clear threat indicators and justifications

Response Fields

statusnumber

HTTP status code (always 200 for successful requests)

successboolean

Indicates if the analysis was successful

analysisIdstring | null

Unique identifier for this analysis (UUID format)

cachedboolean

Whether the result was retrieved from cache (previously analyzed email)

scorenumber

Overall risk score (0-100) combining all analysis factors

headerScorenumber | null

Header analysis score (may be null for advanced AI analysis)

bodyScorenumber | null

Content analysis score (may be null for advanced AI analysis)

threatType / typestring | null

Classification: "phishing", "malicious", "spam", "legitimate", or null

confidencenumber | null

AI confidence level (0-100) in the analysis results

tagsstring[]

Array of threat indicators detected (e.g., ["SUSPICIOUS_LINK", "URGENT_LANGUAGE"])

reasoningstring | null

Detailed AI explanation of the analysis findings

falsePositiveChecksstring[]

Indicators that might suggest a false positive

errorstring | null

Error message if analysis failed, null on success

dataobject

Additional analysis data and metadata

Authentication Required

This endpoint requires a valid API key with Premium or higher subscription. Include your API key in the Authorization header as a Bearer token.

Need help integrating our API? Our support team is here to assist you.