Score content

Scores one URL with Content Intelligence without saving a run.

Use this when an agent needs a quick content-quality answer immediately. Use Create Content Intelligence Run when you need a persisted result in the account.

Endpoint

POST /v1/content-intelligence/content/score

Authentication

Header	Required	Value
Authorization	Yes	Bearer sw_api_live_...
Content-Type	Yes	application/json

Required scope:

content_intelligence:content:score

Request Body

Field	Type	Required	Description
url	string	Yes	Page URL to score.
extraction_mode	string	No	Accepts ssr, csr, or full. The current one-off endpoint always executes static SSR extraction; the other values remain accepted for compatibility. Defaults to ssr.
industry	string	No	Optional industry label.
trends	object[]	No	Optional trend set to score against. If omitted, Sleepwalker generates the trend set for the score.
language	string	No	Language code. Defaults to en.
country	string	No	Country/market code. Defaults to US.

See Enums for language and country code formats.

Sleepwalker uses at most the first five supplied trend objects with a non-empty topic. Objects without a usable topic are ignored. If no usable supplied trends remain, the endpoint discovers trends internally and uses the 3-credit mode.

Example Request

curl -s https://api.sleepwalker.ai/v1/content-intelligence/content/score \
  -H "Authorization: Bearer sw_api_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://www.sleepwalker.ai",
    "industry": "AI visibility software",
    "trends": [
      {
        "topic": "AI visibility monitoring",
        "description": "Brands track how AI search engines mention and cite them.",
        "relevance": "high",
        "opportunity": "Show platform-specific citation gaps."
      }
    ],
    "language": "en",
    "country": "US"
  }'

The same request in Python and JavaScript:

Python

import requests

resp = requests.post(
    "https://api.sleepwalker.ai/v1/content-intelligence/content/score",
    headers={"Authorization": "Bearer sw_api_live_..."},
    json={
        "url": "https://www.sleepwalker.ai",
        "industry": "AI visibility software",
        "trends": [
            {
                "topic": "AI visibility monitoring",
                "description": "Brands track how AI search engines mention and cite them.",
                "relevance": "high",
                "opportunity": "Show platform-specific citation gaps.",
            }
        ],
        "language": "en",
        "country": "US",
    },
)
resp.raise_for_status()
print(resp.json())

JavaScript

const resp = await fetch("https://api.sleepwalker.ai/v1/content-intelligence/content/score", {
  method: "POST",
  headers: {
    Authorization: "Bearer sw_api_live_...",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    url: "https://www.sleepwalker.ai",
    industry: "AI visibility software",
    trends: [
      {
        topic: "AI visibility monitoring",
        description: "Brands track how AI search engines mention and cite them.",
        relevance: "high",
        opportunity: "Show platform-specific citation gaps.",
      },
    ],
    language: "en",
    country: "US",
  }),
});
const data = await resp.json();
console.log(data);

Response

{
  "content_score": {
    "url": "https://www.sleepwalker.ai",
    "extraction_mode": "ssr",
    "engine_mode": "ssr_only",
    "http_status": 200,
    "language": "en",
    "country": "US",
    "industry": "AI visibility software",
    "trends": [
      {
        "topic": "AI visibility monitoring",
        "description": "Brands track how AI search engines mention and cite them.",
        "relevance": "high",
        "opportunity": "Show platform-specific citation gaps."
      }
    ],
    "trend_count": 1,
    "trend_source": "provided",
    "page_type": "homepage",
    "scope": "Explains the Sleepwalker product and workflow.",
    "sufficiency": {
      "verdict": "strong",
      "score": 82,
      "reasoning": "The page explains the core workflow and pricing."
    },
    "freshness": {
      "score": 78,
      "reasoning": "The page appears current but could expose stronger dated proof points."
    },
    "trend_scores": [
      {
        "topic": "AI visibility monitoring",
        "topic_label": "AI Visibility Monitoring",
        "canonical_id": "ai-visibility-monitoring",
        "relevance": 98,
        "coverage": 88,
        "gap": "Show concrete platform-by-platform visibility examples.",
        "recommendation_label": "Add Platform Examples",
        "recommendation": "Show comparative examples from each supported platform."
      }
    ],
    "trend_score_count": 1,
    "overall_score": 81,
    "overall_band": "Good",
    "overall_score_note": "Strong coverage with room for sharper proof points.",
    "top_recommendations": [
      "Show comparative platform wins.",
      "Explain citation provenance.",
      "Translate scores into action."
    ],
    "top_recommendation_labels": [
      "Add Platform Examples",
      "Explain Citation Provenance",
      "Connect Scores to Actions"
    ],
    "analysis_date": "2026-06-10",
    "billing": {
      "billable": true,
      "estimated_credits": "2.00"
    },
    "payload_limits": {
      "content_view_returned": false,
      "raw_extraction_returned": false,
      "raw_llm_response_returned": false,
      "max_trend_count": 5,
      "max_trend_score_count": 5,
      "max_recommendation_count": 3
    }
  }
}

Credits

Mode	Credits
Score with trends	2
Score without trends	3

If the page is blocked, unavailable, or cannot be scored, the response includes billing.billable: false.

Errors

Status	Meaning
400	Invalid URL or unsupported extraction_mode.
401	Missing or invalid API key.
402	Insufficient credits for a billable request.
403	API key is missing content_intelligence:content:score.
422	url is missing, or a request field has the wrong type.
503	Credit storage is temporarily unavailable. Try again shortly.

Extraction/provider failures and API-key rate limits are documented in Errors.