Generate Article

Generate a structured, type-specific article outline

Changed on

Generates the structured outline for an article (listicle/guide/comparison/review/news) from a title + keywords + optional prompt insights and competitor URLs. The outline MUST be produced by this tool - its shape is type-specific and strict. Returns { outline, auto_selections, competitive_analysis, optimization_scope }. To create an article from it, pass the WHOLE returned object as articleOutline.generateOutlineResponse to create_article (or just use the one-shot generate_article).

get/v3/generate-article/generate-outline

Request

  • Base URL: https://api.snowseo.com
  • URL: https://api.snowseo.com/v3/generate-article/generate-outline
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

titlestring required

Article title (required).

type'listicle' | 'comparison' | 'news' | 'review' | 'guide'

Article type. Defaults to listicle. Selects the outline structure.

content_article_type'pillar' | 'cluster'

Omit for a standalone post.

string
OR
string[]

Primary target keywords.

string
OR
string[]

Secondary keywords.

prompt_insights_jsonstring

JSON-stringified array of prompt-insight rows the article should answer.

article_topicstring

Topic cluster the article belongs to.

string
OR
string[]

Up to 5 competitor article URLs to inform competitive analysis.

lengthstring

Target word count: 'auto', a number like '1900', or a label.

tonestring
audiencestring
countrystring
languagestring

Response

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.

Changes

  • e0163b1c37cbRevision changes
    • breaking

      api path removed without deprecation

    • info

      endpoint added

  • 8f92b00b75d6Revision changes
    • breaking

      the query request parameter content_article_type was restricted to a list of enum values

    • breaking

      the query request parameter type was restricted to a list of enum values

    • info

      added the new enum value cluster to the query request parameter content_article_type

    • info

      added the new enum value comparison to the query request parameter type

    • info

      added the new enum value guide to the query request parameter type

    • info

      added the new enum value listicle to the query request parameter type

    • info

      added the new enum value news to the query request parameter type

    • info

      added the new enum value pillar to the query request parameter content_article_type

    • info

      added the new enum value review to the query request parameter type