API Documentation

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

API Health Status

Coming Soon

Monitor the operational status and availability of the AntiBait API.

Endpoint Not Yet Available

The dedicated health check endpoint is currently under development. In the meantime, you can verify API availability by making a request to any authenticated endpoint. A successful response indicates the API is operational.

Planned API Endpoint

GET

GET/api/health

Request Body

No request body needed

Expected Response

{
  "status": "ok" 
  | "degraded" | "down",
  "timestamp": "ISO-8601 string",
  "version": "string"
}

Current Health Check Methods

Test with Basic Analysis

Make a minimal request to verify API availability:

curl -X POST https://api.antibait.io/api/analysis/basic \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"email":"From: [email protected]\n\nTest"}'

Check Response Times

Monitor the response time and HTTP status codes of your regular API calls. Successful responses (HTTP 200) indicate operational status.

Status Updates

Subscribe to our status page or follow system announcements for real-time updates on API availability and maintenance windows.

Stay Updated

We're actively developing this feature. Check back soon or contact our support team at [email protected] for updates on availability.

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

Contact • View FAQ • Manage API Keys