Authentication
All API requests require authentication using an API key. Include your key in the Authorization header.
Authorization: Bearer YOUR_API_KEY
To obtain an API key, upgrade to an Enterprise plan or contact sales for a trial key.
Base URL
https://api.shoutmint.com/v1
Rate Limits
| Plan | Requests/min | Requests/day |
|---|---|---|
| Professional | 10 | 100 |
| Enterprise | 100 | 10,000 |
Audit Website
POST
/audit
Initiates an AI visibility audit for a website.
Request Body
| Parameter | Type | Status | Description |
|---|---|---|---|
| url | string | Required | Website URL to audit |
| industry | string | Optional | Industry category for benchmarking |
| competitors | array | Optional | Up to 3 competitor URLs |
Example Request
curl -X POST https://api.shoutmint.com/v1/audit \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com",
"industry": "saas",
"competitors": ["https://competitor1.com"]
}'
Example Response
{
"id": "audit_123456",
"status": "completed",
"url": "https://example.com",
"scores": {
"overall": 72,
"chatgpt": 75,
"perplexity": 70,
"gemini": 71
},
"results": {
"robotsTxt": {
"found": true,
"allowsAICrawlers": true
},
"schema": {
"schemaCount": 5,
"hasFAQ": true,
"hasOrganization": true
}
}
}
Batch Audit
POST
/batch
Initiate multiple audits simultaneously.
curl -X POST https://api.shoutmint.com/v1/batch \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"urls": [
"https://site1.com",
"https://site2.com"
],
"webhook": "https://your-app.com/webhook"
}'
Get Results
GET
/audit/:id
Retrieve results for a completed audit.
curl https://api.shoutmint.com/v1/audit/audit_123456 \
-H "Authorization: Bearer YOUR_API_KEY"
Webhooks
Configure webhooks to receive real-time notifications when audits complete.
{
"event": "audit.completed",
"data": {
"auditId": "audit_123456",
"url": "https://example.com",
"scores": { ... },
"reportUrl": "https://api.shoutmint.com/v1/reports/audit_123456.pdf"
}
}
Error Codes
| Code | Description |
|---|---|
| 400 | Bad Request - Invalid parameters |
| 401 | Unauthorized - Invalid API key |
| 429 | Rate Limit Exceeded |
| 500 | Internal Server Error |
SDKs & Libraries
Official SDKs make integration even easier:
- JavaScript/Node.js: npm install @shoutmint/api
- Python: pip install shoutmint
- PHP: composer require shoutmint/api
- Ruby: gem install shoutmint