API Documentation
Getting Started
The Email Scanning API allows you to upload files, get a job ID, and retrieve results in JSON format. Follow these steps to get started:
- Sign up for an account
- Create an API key in your dashboard
- Use the API key to authenticate your requests
- Upload a file to get a job ID
- Query the job status and retrieve results
Authentication
All API requests require authentication using an API key. Include your API key in thex-api-key
header with each request.
curl -X POST \
-H "x-api-key: mapi_your_api_key" \
-F "[email protected]" \
-F "save_screenshot=true" \
-F "save_email=false" \
"https://scan.mesasecurity.com/api/v1/scan"
Rate Limiting
API requests are rate-limited based on your plan. The rate limit is applied on a daily basis. Rate limit information is included in the response headers:
X-RateLimit-Limit
: Your daily request limitX-RateLimit-Remaining
: Remaining requests for the dayX-RateLimit-Reset
: Time when the rate limit resets