Base URL
All endpoints are relative to:
https://api.aimodehub.com/v1 All requests must be made over HTTPS.
Authentication
All API requests require an API key. Provide it in the Authorization header:
curl -H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
https://api.aimodehub.com/v1/analyze Endpoints
POST /analyze
Analyze a URL or HTML payload for AI visibility and citation readiness signals.
Request
{
"url": "https://example.com/page/"
} Response
{
"summary": {
"score": 72,
"opportunities": 14
},
"citations": {
"current": 65,
"potential": 90
}
} GET /citations
Retrieve recent citation observations for a domain.
Query parameters
-
domain(required): domain name (example:example.com) -
window(optional): time window (example:30d)
Example
GET /citations?domain=example.com&window=30d Response
{
"citations": [
{
"query": "AI search optimization",
"cited_url": "https://example.com/guide/",
"timestamp": "2024-12-15T10:30:00Z",
"position": 1
}
],
"total_citations": 45,
"visibility_score": 78
} Errors
Common error responses:
-
401 Unauthorized: missing/invalid API key -
429 Too Many Requests: rate limit exceeded 5xx: transient server errors
Support
If you need help integrating the API, contact us via /contact.html.