REST-API

API-Dokumentation

Mit der aiready.tools-API löst du GEO-Audits aus, fragst den Status ab und rufst vollständige Ergebnisse programmatisch ab. Ideal, um KI-Sichtbarkeits-Checks in deine CI/CD-Pipeline, dein CMS oder deine Reporting-Dashboards zu integrieren.

Basis-URL

https://aiready.tools/api/

Authentifizierung

Übergib deinen API-Schlüssel im Request-Header:

X-API-Key: dein_api_schluessel

Deinen API-Schlüssel findest du in deinem Dashboard unter Einstellungen → API.

POST /api/audit.php

Löst einen neuen GEO-Audit aus. Liefert eine job_id für die Status-Abfrage.

REQUEST-BODY (JSON)

Parameter	Typ	Pflicht	Beschreibung
`url`	string	pflicht	Vollständige URL inklusive https://
`modules`	array	optional	Teilmenge der Module. Standard: alle 8.
`webhook_url`	string	optional	POST-Callback, sobald der Audit abgeschlossen ist.

curl -X POST https://aiready.tools/api/audit.php \

  -H "X-API-Key: dein_schluessel" \

  -H "Content-Type: application/json" \

  -d '{"url":"https://example.com"}'

// Antwort

{

  "job_id": "a3f9b2c1d4e5",

  "status": "queued",

  "estimated_seconds": 30

}

GET /api/audit_status.php?job_id={id}

Fragt den Audit-Status ab. Liefert queued, running oder complete.

// Antwort bei Abschluss

{

  "job_id": "a3f9b2c1d4e5",

  "status": "complete",

  "geo_score": 63,

  "results_url": "https://aiready.tools/results.php?url=https://example.com"

}

GET /api/audit.php?url={url}

Ruft die vollständigen Audit-Daten einer bereits analysierten URL als JSON ab (innerhalb des 7-Tage-Caches).

// Verkürzte Antwortstruktur

{

  "geo_score": 63,

  "verdict": "Fair",

  "modules": {

    "citability": { "score": 58, "findings": [...] },

    "brand":      { "score": 41, "platforms": {...} },

    "eeat":       { "score": 67, "signals": [...] },

    "crawlers":   { "score": 100, "blocked": [], "allowed": [...] },

    "schema":     { "score": 28, "types_found": [...] },

    "platforms":  { "score": 55, "chatgpt": {...}, "perplexity": {...} },

    "llmstxt":    { "score": 0, "exists": false, "cta_url": "..." },

    "agent_pricing": { "score": 44, "applicable": true, "findings": [...] }

  },

  "action_plan": [...],

  "analyzed_at": "2026-03-30T12:00:00Z"

}

Fehlercodes

Code	Bedeutung
401	API-Schlüssel fehlt oder ist ungültig
403	Der Plan enthält keinen API-Zugang
422	Ungültige URL oder Domain nicht erreichbar
429	Rate-Limit überschritten
500	Interner Fehler — nach 60 s erneut versuchen

Rate-Limits

Agency-Plan: 100 API-Anfragen pro Stunde. Maximal 5 gleichzeitige Audits. Jede Antwort enthält die Rate-Limit-Header X-RateLimit-Remaining und X-RateLimit-Reset.