Generate a structured, type-specific article outline
curl --request POST \
--url https://api.snowseo.com/v3/generate-article/generate-outline \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"primary_keywords": "<string>",
"secondary_keywords": "<string>",
"prompt_insights_json": "<string>",
"article_topic": "<string>",
"competitor_articles": "<string>",
"length": "<string>",
"tone": "<string>",
"audience": "<string>",
"country": "<string>",
"language": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/generate-article/generate-outline"
payload = {
"title": "<string>",
"primary_keywords": "<string>",
"secondary_keywords": "<string>",
"prompt_insights_json": "<string>",
"article_topic": "<string>",
"competitor_articles": "<string>",
"length": "<string>",
"tone": "<string>",
"audience": "<string>",
"country": "<string>",
"language": "<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({
title: '<string>',
primary_keywords: '<string>',
secondary_keywords: '<string>',
prompt_insights_json: '<string>',
article_topic: '<string>',
competitor_articles: '<string>',
length: '<string>',
tone: '<string>',
audience: '<string>',
country: '<string>',
language: '<string>'
})
};
fetch('https://api.snowseo.com/v3/generate-article/generate-outline', 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-outline",
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([
'title' => '<string>',
'primary_keywords' => '<string>',
'secondary_keywords' => '<string>',
'prompt_insights_json' => '<string>',
'article_topic' => '<string>',
'competitor_articles' => '<string>',
'length' => '<string>',
'tone' => '<string>',
'audience' => '<string>',
'country' => '<string>',
'language' => '<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-outline"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<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-outline")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/generate-article/generate-outline")
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 \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>"Article Generation
Generate Outline
Generate a structured, type-specific article outline.
POST
/
v3
/
generate-article
/
generate-outline
Generate a structured, type-specific article outline
curl --request POST \
--url https://api.snowseo.com/v3/generate-article/generate-outline \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"primary_keywords": "<string>",
"secondary_keywords": "<string>",
"prompt_insights_json": "<string>",
"article_topic": "<string>",
"competitor_articles": "<string>",
"length": "<string>",
"tone": "<string>",
"audience": "<string>",
"country": "<string>",
"language": "<string>"
}
'import requests
url = "https://api.snowseo.com/v3/generate-article/generate-outline"
payload = {
"title": "<string>",
"primary_keywords": "<string>",
"secondary_keywords": "<string>",
"prompt_insights_json": "<string>",
"article_topic": "<string>",
"competitor_articles": "<string>",
"length": "<string>",
"tone": "<string>",
"audience": "<string>",
"country": "<string>",
"language": "<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({
title: '<string>',
primary_keywords: '<string>',
secondary_keywords: '<string>',
prompt_insights_json: '<string>',
article_topic: '<string>',
competitor_articles: '<string>',
length: '<string>',
tone: '<string>',
audience: '<string>',
country: '<string>',
language: '<string>'
})
};
fetch('https://api.snowseo.com/v3/generate-article/generate-outline', 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-outline",
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([
'title' => '<string>',
'primary_keywords' => '<string>',
'secondary_keywords' => '<string>',
'prompt_insights_json' => '<string>',
'article_topic' => '<string>',
'competitor_articles' => '<string>',
'length' => '<string>',
'tone' => '<string>',
'audience' => '<string>',
'country' => '<string>',
'language' => '<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-outline"
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<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-outline")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/generate-article/generate-outline")
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 \"title\": \"<string>\",\n \"primary_keywords\": \"<string>\",\n \"secondary_keywords\": \"<string>\",\n \"prompt_insights_json\": \"<string>\",\n \"article_topic\": \"<string>\",\n \"competitor_articles\": \"<string>\",\n \"length\": \"<string>\",\n \"tone\": \"<string>\",\n \"audience\": \"<string>\",\n \"country\": \"<string>\",\n \"language\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body"<string>"Generate the structured outline for an article (listicle, guide, comparison, review, or news) from a title, keywords, and optional prompt insights and competitor URLs.
JSON body fields:
title (required), type (listicle default, comparison, news, review, guide), content_article_type (pillar or cluster), primary_keywords, secondary_keywords, prompt_insights_json (JSON-stringified array), article_topic, competitor_articles (up to 5 URLs), length (auto or a word count), tone, audience, country, language, and custom_instructions. The response streams newline-delimited JSON (application/x-ndjson); the final line is { outline, auto_selections, competitive_analysis, optimization_scope }. An error after streaming starts arrives as an error line with HTTP 200. Limited to 20 requests per minute.
The outline shape is type-specific and strict - it is meant to be generated, not hand-written. Pass the whole returned object as
articleOutline.generateOutlineResponse to Create Article, or use Generate Article to do everything in one call.Authorizations
bearerAuthapiKey
Your SnowSEO API key (sk_...).
Body
application/json
Article title (required).
Article type. Defaults to listicle. Selects the outline structure.
Available options:
listicle, comparison, news, review, guide Omit for a standalone post.
Available options:
pillar, cluster Primary target keywords.
Secondary keywords.
JSON-stringified array of prompt-insight rows the article should answer.
Topic cluster the article belongs to.
Up to 5 competitor article URLs to inform competitive analysis.
Target word count: 'auto', a number like '1900', or a label.
Response
200 - application/x-ndjson
A newline-delimited stream. Whitespace keeps the connection alive; status and final result are JSON lines. An error after streaming starts is returned as a JSON error line with HTTP 200.
Newline-delimited JSON events
Was this page helpful?

