Generate Article

Start article generation

Changed on

Start generating content for an existing draft article (one created by create_article) - the wizard's final step. CONSUMES CREDITS: always ask the user for permission before calling this (the earlier wizard steps - titles, outline, keywords, prompts - are free). Generation runs in the background - poll generation_status with the same slug until it is no longer generating, then read the result with get_article. Calling this again while a run is already in progress is safe and will not start a duplicate.

post/v3/generate-article/start

Request

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

Request body

teamIdstring

Team id (falls back to the session's active project).

slugstring required

Slug of the draft article to generate.

customInstructionsstring

Optional free-text writing instructions for this article, layered on top of the team's default content guidelines. Persists onto the article for future regenerations. Omit to leave the stored value unchanged; send an empty string to clear it.

customInstructionsUseWithBrandboolean

When true (default), the article's custom instructions are applied together with the brand's content guidelines. When false, they replace the brand guidelines for this article. Persists onto the article.

targetWordCountinteger

Target article length in words. Only used when the draft has NO outline yet - the worker plans one and this sets its size (and the credit cost). Ignored when an outline already exists, since its own target wins. Defaults to 1900.

Response

Success: { success:true, generating:true, slug } (+ alreadyRunning:true when a run was already in flight). Insufficient credits: { success:false, generating:false, requiredCredits, message }.

successboolean
generatingboolean
slugstring
requiredCreditsnumber
messagestring
alreadyRunningboolean

Changes