Skip to main content
POST
/
v1
/
keywords
/
{id}
/
report
Generate SEO report
curl --request POST \
  --url https://api.example.com/v1/keywords/{id}/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contentId": "<string>",
  "html": "<string>",
  "metaDescription": "<string>",
  "title": "<string>"
}
'
{
  "competitors": [
    {
      "isFeaturedSnippet": true,
      "position": 123,
      "title": "<string>",
      "url": "<string>",
      "wordsCount": 123
    }
  ],
  "recommendations": {
    "articleWordsCount": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "focusKeywordInTitle": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "incomingLinks": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "outgoingLinks": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "questionsSuggestion": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "searchIntentsSuggestion": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    },
    "topicsSuggestion": {
      "score": 123,
      "data": {},
      "items": [
        {}
      ]
    }
  },
  "score": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.semji.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
required

API key starting with sk_. Generate one in Settings > API Keys.

Path Parameters

id
string
required

Keyword ID.

Body

application/json
contentId
string

Content ID to score (fetches HTML automatically).

html
string

HTML content to score.

metaDescription
string

Meta description (optional). Accepted for forward compatibility but currently NOT factored into recommendations — the score is computed from title and html only.

title
string

Title of the content to score.

Response

200 - application/json

Default Response

competitors
object[]
required

SERP competitors.

recommendations
object
required

Typed SEO recommendations.

score
number
required

Overall SEO score (0.0 - 1.0).