Suggest internal links for an article
curl --request POST \
--url https://api.snowseo.com/v3/generate-article/generate-internal-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"current_title": "<string>",
"topic_id": "<string>",
"exclude_article_slug": "<string>",
"team_id": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/generate-article/generate-internal-links"
payload = {
"current_title": "<string>",
"topic_id": "<string>",
"exclude_article_slug": "<string>",
"team_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
current_title: '<string>',
topic_id: '<string>',
exclude_article_slug: '<string>',
team_id: '<string>'
})
};
fetch('https://api.snowseo.com/v3/generate-article/generate-internal-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/generate-article/generate-internal-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'current_title' => '<string>',
'topic_id' => '<string>',
'exclude_article_slug' => '<string>',
'team_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/generate-article/generate-internal-links"
payload := strings.NewReader("{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snowseo.com/v3/generate-article/generate-internal-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/generate-article/generate-internal-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"output": {
"internal_links": [
{
"id": "<string>",
"title": "<string>",
"url": "<string>",
"relevance_score": 123,
"articleSlug": "<string>",
"isRecommended": true
}
]
}
}Article Generation
Suggest Internal Links
Suggest relevant internal links for a new article.
POST
/
v3
/
generate-article
/
generate-internal-links
Suggest internal links for an article
curl --request POST \
--url https://api.snowseo.com/v3/generate-article/generate-internal-links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"current_title": "<string>",
"topic_id": "<string>",
"exclude_article_slug": "<string>",
"team_id": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/generate-article/generate-internal-links"
payload = {
"current_title": "<string>",
"topic_id": "<string>",
"exclude_article_slug": "<string>",
"team_id": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
current_title: '<string>',
topic_id: '<string>',
exclude_article_slug: '<string>',
team_id: '<string>'
})
};
fetch('https://api.snowseo.com/v3/generate-article/generate-internal-links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.snowseo.com/v3/generate-article/generate-internal-links",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'current_title' => '<string>',
'topic_id' => '<string>',
'exclude_article_slug' => '<string>',
'team_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.snowseo.com/v3/generate-article/generate-internal-links"
payload := strings.NewReader("{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.snowseo.com/v3/generate-article/generate-internal-links")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/generate-article/generate-internal-links")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"current_title\": \"<string>\",\n \"topic_id\": \"<string>\",\n \"exclude_article_slug\": \"<string>\",\n \"team_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"output": {
"internal_links": [
{
"id": "<string>",
"title": "<string>",
"url": "<string>",
"relevance_score": 123,
"articleSlug": "<string>",
"isRecommended": true
}
]
}
}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
bearerAuthapiKey
Your SnowSEO API key (sk_...).
Body
application/json
Title of the article that will link out.
Topic cluster id (required when content_article_type is set).
Omit for a standalone post.
Available options:
pillar, cluster Slug to exclude from suggestions (e.g. the article itself).
Response
200 - application/json
Default Response
Show child attributes
Show child attributes
Was this page helpful?

