Skip to main content
POST
Suggest internal links for an article
Suggest the most relevant existing articles to link to from a new article, ranked by relevance. JSON body fields: current_title (required), topic_id (required when content_article_type is set; 404 if it is not one of your topics), content_article_type (pillar or cluster), and exclude_article_slug. The response is { output: { internal_links } }, each with id, title, url, relevance_score, articleSlug, and isRecommended. Limited to 20 requests per minute. Pass the returned slugs to Create Article or Generate Article as internalLinkTargetSlugs.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Body

application/json
current_title
string
required

Title of the article that will link out.

topic_id
string

Topic cluster id (required when content_article_type is set).

content_article_type
enum<string>

Omit for a standalone post.

Available options:
pillar,
cluster
exclude_article_slug
string

Slug to exclude from suggestions (e.g. the article itself).

team_id
string

Response

200 - application/json

Default Response

output
object
required