GeoFN API Documentation
Integrate Generative Engine Optimization (GEO) audits, AI bot access control, and citation extraction directly into your CI/CD pipelines, agentic workflows, and internal marketing dashboards.
Overview & Authentication
All endpoints are hosted over HTTPS at https://geofn.com/api.
Public tier endpoints (e.g. deterministic technical audits and health probes) require no API keys but enforce IP-based rate limiting (10 RPM). Enterprise and Agency plan endpoints support Bearer Token authentication.
API Reference
/api/auditExecutes an instant, deterministic inspection of a target domain's AI accessibility: checks robots.txt whitelist coverage, /llms.txt compliance, and Schema.org structured data.
Example Request
curl -X POST https://geofn.com/api/audit \
-H "Content-Type: application/json" \
-d '{"domain": "stripe.com"}'Example Response (200 OK)
{
"domain": "stripe.com",
"healthScore": 95,
"robotsStatus": "pass",
"llmsTxtStatus": "pass",
"jsonLdDetected": true,
"aiCrawlerAllowed": {
"gptBot": true,
"claudeBot": true,
"perplexityBot": true
}
}/api/healthReturns the live status of the GeoFN API gateway and operational telemetry.
{
"status": "pass",
"service": "geofn-api",
"version": "0.1.0",
"timestamp": "2026-10-12T13:50:00.000Z"
}/.well-known/api-catalogMachine-readable API discovery document per RFC 9727. Returns link relations for OpenAPI specification (service-desc), developer documentation (service-doc), and health probe (status).
curl -H "Accept: application/linkset+json" https://geofn.com/.well-known/api-catalog
Prefer Command Line / Local Audits?
You can also use our open-source CLI without network dependencies or registration:
npx open-geo audit https://example.com