API DOCUMENTATION

Complete REST API reference for Seerror website security and SEO analysis platform

COMING SOON

BASE URL

All API requests should be made to:

https://seerror-backend.fly.dev

AUTHENTICATION

API authentication is coming soon. Currently, the API is open for testing.

Future authentication will use API keys passed in the Authorization header:

Authorization: Bearer YOUR_API_KEY

ENDPOINTS

POST /inspect

Complete website analysis with configurable audits. Returns comprehensive security, SEO, and performance analysis.

Request Body

Parameter Type Required Description
url string Yes The website URL to analyze (must include http:// or https://)
audits object No Configuration object for which audits to run
audits.security boolean No Enable security audit (default: true)
audits.seo boolean No Enable SEO audit (default: true)
audits.performance boolean No Enable performance audit (default: true)

Example Request

const response = await fetch('https://seerror-backend.fly.dev/inspect', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    url: 'https://example.com',
    audits: {
      security: true,
      seo: true,
      performance: true
    }
  })
});

const data = await response.json();
console.log(data);
import requests

url = 'https://seerror-backend.fly.dev/inspect'
payload = {
    'url': 'https://example.com',
    'audits': {
        'security': True,
        'seo': True,
        'performance': True
    }
}

response = requests.post(url, json=payload)
data = response.json()
print(data)
curl -X POST https://seerror-backend.fly.dev/inspect \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "audits": {
      "security": true,
      "seo": true,
      "performance": true
    }
  }'
$url = 'https://seerror-backend.fly.dev/inspect';
$data = [
    'url' => 'https://example.com',
    'audits' => [
        'security' => true,
        'seo' => true,
        'performance' => true
    ]
];

$options = [
    'http' => [
        'header' => "Content-Type: application/json\r\n",
        'method' => 'POST',
        'content' => json_encode($data)
    ]
];

$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
print_r($response);

Response

{
  "security_score": 85,
  "seo_score": 92,
  "performance_score": 78,
  "vulnerabilities": [...],
  "seo_issues": [...],
  "performance_metrics": {...},
  ...
}
POST /chat

AI chat assistant for website analysis queries. Ask questions about your website's security, SEO, or performance.

Request Body

Parameter Type Required Description
message string Yes Your question or message to the AI assistant
url string No Website URL for context (optional)

Example Request

const response = await fetch('https://seerror-backend.fly.dev/chat', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    message: 'What are the main security issues on my website?',
    url: 'https://example.com'
  })
});

const data = await response.json();
console.log(data.response);
import requests

url = 'https://seerror-backend.fly.dev/chat'
payload = {
    'message': 'What are the main security issues on my website?',
    'url': 'https://example.com'
}

response = requests.post(url, json=payload)
data = response.json()
print(data['response'])
curl -X POST https://seerror-backend.fly.dev/chat \
  -H "Content-Type: application/json" \
  -d '{
    "message": "What are the main security issues on my website?",
    "url": "https://example.com"
  }'
$url = 'https://seerror-backend.fly.dev/chat';
$data = [
    'message' => 'What are the main security issues on my website?',
    'url' => 'https://example.com'
];

$options = [
    'http' => [
        'header' => "Content-Type: application/json\r\n",
        'method' => 'POST',
        'content' => json_encode($data)
    ]
];

$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
echo $response['response'];
GET /health

Check API health status and system metrics. Useful for monitoring and uptime checks.

Example Request

const response = await fetch('https://seerror-backend.fly.dev/health');
const data = await response.json();
console.log(data);
import requests

url = 'https://seerror-backend.fly.dev/health'
response = requests.get(url)
data = response.json()
print(data)
curl https://seerror-backend.fly.dev/health
$url = 'https://seerror-backend.fly.dev/health';
$result = file_get_contents($url);
$response = json_decode($result, true);
print_r($response);
POST /advanced-scan

Deep scanning with configurable depth and scope. More comprehensive analysis than standard inspection.

Request Body

Parameter Type Required Description
url string Yes The website URL to scan
depth integer No Scanning depth (1-5, default: 3)
scope string No Scan scope: 'full', 'security', 'seo', 'performance'
POST /reset

Reset chat memory and conversation history. Clears the AI assistant's context.

Example Request

const response = await fetch('https://seerror-backend.fly.dev/reset', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  }
});

const data = await response.json();
console.log(data);
import requests

url = 'https://seerror-backend.fly.dev/reset'
response = requests.post(url)
data = response.json()
print(data)
curl -X POST https://seerror-backend.fly.dev/reset \
  -H "Content-Type: application/json"
$url = 'https://seerror-backend.fly.dev/reset';
$options = [
    'http' => [
        'header' => "Content-Type: application/json\r\n",
        'method' => 'POST'
    ]
];

$context = stream_context_create($options);
$result = file_get_contents($url, false, $context);
$response = json_decode($result, true);
print_r($response);

RATE LIMITS

Rate limits will be implemented when API authentication is enabled.

Expected limits:

  • Free tier: 10 requests/hour
  • Professional: 100 requests/day
  • Business: 1000 requests/day

ERROR HANDLING

All errors are returned in JSON format with appropriate HTTP status codes:

Error Response Format

{
  "detail": "Error message description"
}

Status Codes

Code Description
200 Success
400 Bad Request - Invalid parameters
401 Unauthorized - Invalid or missing API key
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error

READY TO GET STARTED?

Contact us to get your API key and start integrating Seerror into your applications.

CONTACT FOR API KEY INTERACTIVE API DOCS - COMING SOON