API Documentation

Integrate the AI Recommendation Readiness Audit into your applications and workflows.

Overview

The AI Recommendation Readiness Audit API allows you to programmatically submit audits, retrieve reports, and generate content recommendations. Public endpoints are accessible without authentication. Content generation endpoints require admin authentication.

Base URL: /api

Format: JSON

Endpoints

Submit business details and audit answers to create a new audit report.

Request Body

{
  "businessInfo": {
    "businessName": "Acme Plumbing",
    "websiteUrl": "https://acmeplumbing.com",
    "businessCategory": "Plumber",
    "cityState": "Phoenix, AZ",
    "industry": "Home Services",
    "contactName": "Jane Smith",
    "email": "[email protected]",
    "phone": "(555) 123-4567",
    "mainCustomerType": "Homeowners",
    "topServices": "Water heater repair, Drain cleaning, Pipe installation",
    "biggestConcern": "Not sure if AI can find my business"
  },
  "answers": [
    { "questionId": 1, "categoryId": 1, "answer": "yes", "score": 100 },
    { "questionId": 2, "categoryId": 1, "answer": "somewhat", "score": 60 }
  ],
  "overallScore": 62,
  "resultLevel": "Partially Ready",
  "categoryScores": { "1": 75, "2": 60, "3": 55, "4": 65, "5": 50, "6": 70, "7": 45, "8": 55 },
  "topStrengths": [{ "id": 1, "name": "Identity Clarity", "score": 75 }],
  "topWeaknesses": [{ "id": 7, "name": "AI Usability & DSA Readiness", "score": 45 }]
}

Response

{
  "id": "clxyz123abc",
  "score": 62,
  "resultLevel": "Partially Ready"
}

MCP-Ready Tool Concept

This API is designed to be compatible with future Model Context Protocol (MCP) integrations. AI assistants will be able to:

• Submit audit data on behalf of a business owner
• Retrieve and summarize audit reports in conversation
• Generate content recommendations based on audit results
• Recommend Decision Support Asset ideas relevant to the business

MCP integration is a planned future feature. Current API endpoints function as standard REST endpoints.