Skip to main content
POST
/
v1
/
pages
/
{pageId}
/
keywords
Add a keyword to a page
curl --request POST \
  --url https://api.example.com/v1/pages/{pageId}/keywords \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "keyword": "<string>"
}
'
{
  "analysisStatus": "queued",
  "analyzed": true,
  "clicks": 123,
  "createdAt": "<string>",
  "ctr": 123,
  "focusPrompt": {
    "id": "<string>",
    "prompt": "<string>"
  },
  "id": "<string>",
  "impressions": 123,
  "isCannibalized": true,
  "keyword": "<string>",
  "keywordDifficulty": 123,
  "position": 123,
  "searchVolume": 123,
  "source": "<string>"
}

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

pageId
string
required

Page ID.

Body

application/json
keyword
string
required

The keyword text.

Required string length: 1 - 255

Response

201 - application/json

Default Response

analysisStatus
enum<string> | null
required

Status of the SEO analysis.

Available options:
queued,
pending,
success,
failed
analyzed
boolean
required

Whether the keyword has been analyzed.

clicks
number | null
required

Search clicks.

createdAt
string
required

ISO 8601 creation date.

ctr
number | null
required

Click-through rate.

focusPrompt
object
required

Focus GEO prompt linked to this keyword.

id
string
required

Unique identifier of the keyword.

impressions
number | null
required

Search impressions.

isCannibalized
boolean | null
required

Whether the keyword is cannibalized.

keyword
string
required

The keyword text.

keywordDifficulty
number | null
required

SEO difficulty score (0-100).

position
number | null
required

Current SERP position.

searchVolume
number | null
required

Monthly search volume.

source
string | null
required

Source of the keyword.