API Documentation

Overview

The Audit SEO Tool API allows you to programmatically create audits, retrieve results, and integrate SEO analysis into your own applications and workflows. The API follows REST conventions and returns JSON responses.

Authentication

All API requests require authentication using an API key. You can generate and manage your API keys in your dashboard settings (available for Professional and Agency plans).

Keep your API key secure. Do not share it publicly or commit it to version control.

Rate Limits

API rate limits vary by plan:

Rate limit headers are included in all API responses: X-RateLimit-Remaining

Endpoints Preview

{
  "url": "https://example.com",
  "options": {
    "deepScan": true,
    "aiAnalysis": true
  }
}

{
  "id": "audit_abc123",
  "status": "processing",
  "url": "https://example.com",
  "createdAt": "2026-01-23T10:00:00Z"
}

{
  "id": "audit_abc123",
  "status": "completed",
  "url": "https://example.com",
  "scores": {
    "overall": 78,
    "seo": 82,
    "aiVisibility": 71,
    "technical": 85,
    "content": 74
  },
  "recommendations": [...],
  "completedAt": "2026-01-23T10:02:30Z"
}

Response Format

All API responses follow a consistent format. Successful responses return the requested data, while errors include a message and error code.

{
  "data": { ... },
  "meta": {
    "requestId": "req_xyz"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests"
  }
}