How well the site is structured for AI search.

A score out of 100 per page, built only from what is on the page: whether it answers directly in the opening sentence, whether subheadings ask real questions, structured data, lists and tables, entity clarity, freshness, a named author, crawlability, scannability and internal links in. This measures readiness, not outcome: nobody can verify whether an AI answer used a page, and this endpoint never claims to.

GEThttps://app.softsolz.uk/api/v1/services/seo/sites/{site_id}/ai-readiness

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

site_idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Response

Response Body

summaryobjectAverage across the pages that have been scored.

weakestarray of objectsLowest scoring first, with the component breakdown.

notestringThe honesty note, shown wherever this score appears.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.seo.getAiReadiness('<site_id>');
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": {
    "summary": {},
    "weakest": [],
    "note": "string"
  }
}