Examples

Static sample request/response shapes. Try live calls in the playground, or fetch JSON at /api/examples/:endpoint.

audit-score

$0.06

/api/audit/score

{
  "url": "https://example.com"
}

{
  "data": {
    "url": "https://example.com/",
    "score": 71,
    "grade": "B",
    "summary": "Score 71/100 (B). Highest-leverage fixes: Publish /llms.txt at the site root; Add Organization + WebSite JSON-LD.",
    "topIssues": [
      {
        "id": "missing_llms_txt",
        "severity": "high",
        "message": "Missing llms.txt at site root",
        "category": "llmsTxt",
        "fix": "Create /llms.txt with: product one-liner, docs/pricing/contact links, and what agents may cite.",
        "path": "/llms.txt",
        "impact": 95
      }
    ],
    "quickWins": [
      {
        "rank": 1,
        "title": "Publish /llms.txt at the site root",
        "action": "Create /llms.txt with: product one-liner, docs/pricing/contact links, and what agents may cite.",
        "path": "/llms.txt",
        "impact": 95,
        "effort": "minutes"
      }
    ]
  }
}

audit-full

$0.15

/api/audit/full

{
  "url": "https://example.com"
}

{
  "data": {
    "score": 68,
    "grade": "C",
    "categories": {
      "llmsTxt": {
        "score": 0,
        "max": 15
      }
    },
    "recommendations": [
      {
        "title": "Add an llms.txt"
      }
    ]
  }
}

audit-deep

$0.35

/api/audit/deep

{
  "url": "https://example.com",
  "crawl": {
    "maxPages": 8
  }
}

{
  "data": {
    "mode": "deep",
    "score": 68,
    "summary": {
      "pagesScanned": 8,
      "issuesFound": 19
    },
    "pageFindings": [
      {
        "path": "/",
        "score": 74
      }
    ]
  }
}

fixes-generate

$0.55

/api/fixes/generate

{
  "url": "https://example.com",
  "issues": [
    "missing_llms_txt"
  ]
}

{
  "data": {
    "fixes": [
      {
        "id": "llms-txt",
        "title": "Create /llms.txt",
        "type": "file",
        "path": "/llms.txt"
      }
    ]
  }
}

compare-suggest

$0.08

/api/compare/suggest

{
  "url": "https://example.com",
  "limit": 3
}

{
  "data": {
    "suggestions": [
      {
        "domain": "competitor.com",
        "confidence": 0.87,
        "fit": "direct"
      }
    ]
  }
}

compare-gap

$0.50

/api/compare/gap

{
  "targetUrl": "https://example.com",
  "competitors": [
    "https://comp1.com"
  ]
}

{
  "data": {
    "targetScore": 64,
    "competitorAverageScore": 79,
    "gapScore": -15,
    "headline": "You trail competitors by 15 pts. Close Schema / structured data first.",
    "areasBehind": [
      {
        "area": "FAQ schema",
        "delta": -58
      }
    ],
    "priorityMoves": [
      {
        "rank": 1,
        "title": "Wrap FAQ copy in FAQPage schema",
        "action": "Add FAQPage JSON-LD matching on-page Q&A (question/acceptedAnswer pairs).",
        "path": "FAQ page JSON-LD",
        "delta": -58,
        "expectedLift": "+18 to overall score if closed to competitor average",
        "evidence": "https://comp1.com scores 90% on schema vs your 32%"
      }
    ]
  }
}

bots-audit

$0.12

/api/bots/audit

{
  "url": "https://example.com"
}

{
  "data": {
    "score": 72,
    "summary": "AI crawlers look open (8/10 allowed). Score 72/100.",
    "bots": [
      {
        "id": "GPTBot",
        "status": "allowed"
      }
    ]
  }
}

llms-generate

$0.25

/api/llms/generate

{
  "url": "https://example.com"
}

{
  "data": {
    "path": "/llms.txt",
    "content": "# Example\n\n> Product summary…\n"
  }
}

cite-check

$0.20

/api/cite/check

{
  "url": "https://stripe.com",
  "prompts": [
    "best payment APIs for startups"
  ]
}

{
  "data": {
    "mentionRate": 100,
    "results": [
      {
        "prompt": "…",
        "mentioned": true,
        "cited": true
      }
    ]
  }
}

schema-generate

$0.40

/api/schema/generate

{
  "url": "https://example.com"
}

{
  "data": {
    "existingTypes": [],
    "missing": [
      "Organization",
      "FAQPage"
    ],
    "blocks": [
      {
        "id": "organization",
        "type": "Organization"
      }
    ]
  }
}

cite-sources

$0.30

/api/cite/sources

{
  "url": "https://stripe.com",
  "prompts": [
    "best payment APIs for startups"
  ]
}

{
  "data": {
    "ownCitationRate": 40,
    "sources": [
      {
        "domain": "g2.com",
        "count": 2,
        "kind": "review"
      }
    ]
  }
}

content-answerability

$0.12

/api/content/answerability

{
  "url": "https://example.com"
}

{
  "data": {
    "score": 58,
    "grade": "D",
    "dimensions": [
      {
        "id": "faqDensity",
        "score": 8,
        "max": 25
      }
    ]
  }
}

meta-extract

$0.02

/api/meta/extract

{
  "url": "https://example.com"
}

{
  "data": {
    "title": "Example Domain",
    "description": null,
    "openGraph": {
      "title": null
    },
    "jsonLdTypes": []
  }
}

probe-fetch

$0.01

/api/probe/fetch

{
  "url": "https://example.com"
}

{
  "data": {
    "status": 200,
    "redirected": false,
    "contentType": "text/html"
  }
}