API Documentation

Integrate AI visibility scoring into your platform

🚀 Enterprise Feature

API access is available for Enterprise customers. Contact sales to request access.

Request API Access →

Overview

The AI Business Score API allows you to programmatically:

Generate visibility snapshots
Retrieve full reports
Monitor scores over time
Integrate AI visibility into your platform

Base URL: https://api.aibusinessscore.com

Authentication: API Key (Bearer token)

Rate Limits: 100 requests/minute (standard), 1000/minute (enterprise)

Authentication

All API requests require an API key in the Authorization header:

Authorization: Bearer abs_live_sk_1234567890abcdef

Key Types

abs_test_sk_* - Test mode (sandbox, no charges)
abs_live_sk_* - Production mode

Endpoints

POST /v1/predict - Generate Snapshot

Create a visibility snapshot for a business.

Request Body

{
  "business_name": "string (required)",
  "city": "string (required)",
  "state": "string (required, 2-letter code)",
  "category": "string (required)",
  "website": "string (optional)",
  "phone": "string (optional)",
  "zip_code": "string (optional)",
  "google_place_id": "string (optional)"
}

Response

{
  "lead_id": "abc-123-def-456",
  "overall_score": 72,
  "visibility_level": "Medium",
  "confidence": "High",
  "categories": {
    "reputation": 85,
    "content_quality": 68,
    "authority": 71,
    "technical": 75,
    "online_presence": 70
  },
  "ai_recognition": {
    "platforms_tested": ["ChatGPT", "Gemini", "Claude"],
    "total_queries": 6,
    "times_mentioned": 3,
    "recognition_rate": 50.0
  },
  "report_url": "https://aibusinessscore.com/report/abc-123"
}

GET /v1/report/{lead_id} - Get Full Report

Retrieve a complete report (requires payment or subscription).

Request

GET /v1/report/abc-123-def-456
Authorization: Bearer YOUR_API_KEY

Response

{
  "lead_id": "abc-123-def-456",
  "business_name": "Acme Pizza",
  "overall_score": 72,
  "visibility_level": "Medium",
  "categories": { ... },
  "recommendations": [ ... ],
  "competitive_analysis": { ... },
  "ai_interpretation": { ... }
}

GET /v1/categories - List Categories

Get all supported business categories.

Response

{
  "categories": [
    "Restaurant",
    "Pizza Restaurant",
    "Italian Restaurant",
    "Plumber",
    "Electrician",
    ...
  ]
}

Code Examples

Python

import requests

api_key = "abs_live_sk_1234567890abcdef"
url = "https://api.aibusinessscore.com/v1/predict"

headers = {
    "Authorization": f"Bearer {api_key}",
    "Content-Type": "application/json"
}

payload = {
    "business_name": "Acme Pizza",
    "city": "Austin",
    "state": "TX",
    "category": "Pizza Restaurant",
    "website": "https://acmepizza.com"
}

response = requests.post(url, json=payload, headers=headers)
data = response.json()

print(f"Score: {data['overall_score']}")
print(f"Report: {data['report_url']}")

JavaScript (Node.js)

const axios = require('axios');

const apiKey = 'abs_live_sk_1234567890abcdef';
const url = 'https://api.aibusinessscore.com/v1/predict';

const payload = {
  business_name: 'Acme Pizza',
  city: 'Austin',
  state: 'TX',
  category: 'Pizza Restaurant',
  website: 'https://acmepizza.com'
};

axios.post(url, payload, {
  headers: {
    'Authorization': `Bearer ${apiKey}`,
    'Content-Type': 'application/json'
  }
})
.then(response => {
  console.log(`Score: ${response.data.overall_score}`);
  console.log(`Report: ${response.data.report_url}`);
})
.catch(error => {
  console.error(error.response.data);
});

Error Handling

Error Format

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: business_name",
    "param": "business_name"
  }
}

Common Errors

400 - Bad Request (missing/invalid parameters)
401 - Unauthorized (invalid API key)
403 - Forbidden (insufficient permissions)
404 - Not Found (report doesn't exist)
429 - Rate Limit Exceeded
500 - Internal Server Error

Rate Limits

Plan	Requests/Minute	Requests/Month
Standard	100	10,000
Enterprise	1,000	100,000
Custom	Negotiable	Unlimited

Support

Need API Access?

Contact our enterprise team to get started

Email: api@aibusinessscore.com Schedule Demo