Skip to main content
POST
Generate FAQ-style prompts for an article
Generate ranked, FAQ-style reader questions for an article’s topic - useful to guide the structure or seed an FAQ section. Requires the article title and its topic cluster name (articleTopic) in a JSON body. Optional: competitor_articles (up to 5 URLs), topicId, country, and language. The response streams newline-delimited JSON (application/x-ndjson): progress lines contain status, and the final line is { prompts }, each with prompt, search_volume, intent, relevance_score, and isRecommended. Limited to 20 requests per day.

Authorizations

Authorization
string
header
required

Your SnowSEO API key (sk_...).

Body

application/json
title
string
required

Article title.

articleTopic
string
required

Topic cluster the article belongs to.

competitor_articles

Up to 5 competitor article URLs to inform the prompts.

topicId
string

Topic cluster id. Its questions that no article covers yet are offered to the model.

teamId
string
country
string
language
string

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