Sign in
latestOpenAPI 3.0.02026-08-08100184.9 KB

91fc72cb99f6

New Article Outline

Generate an outline for a new article. For more examples, visit Example Payloads Documentation.

post/v1/new-outline

Query parameters

api_keystring required

API key for authentication

Request body

article_titlestring required

The title of the article for which the outline is to be generated.

main_keywordstring

The main keyword used to search top-ranking websites for generating article outlines and collecting entities. If left empty, the article title will be used by default, so please ensure that the article title is provided. (Optional)

region'ar' | 'au' | 'be' | 'br' | 'ca' | 'cl' | 'cn' | 'hr' | 'dk' | 'fi' | 'fr' | 'de' | 'hk' | 'hu' | 'in' | 'id' | 'ie' | 'il' | 'it' | 'jp' | 'my' | 'mx' | 'nl' | 'nz' | 'no' | 'ph' | 'pl' | 'pt' | 'ro' | 'rs' | 'sg' | 'za' | 'kr' | 'es' | 'lk' | 'se' | 'ch' | 'tw' | 'th' | 'uk' | 'ua' | 'us' | 'vn' | 'bh' | 'eg' | 'kw' | 'ma' | 'om' | 'sa' | 'tn' | 'ae' required

The region for which the article is targeted.

output_language'American English' | 'Australian English' | 'British English' | 'Canadian English' | 'Simplified Chinese' | 'Traditional Chinese' | 'Malay' | 'Arabic' | 'Brazilian Portuguese' | 'Croatian' | 'Danish' | 'Dutch' | 'German' | 'French' | 'Hebrew' | 'Hungarian' | 'Indonesian' | 'Italian' | 'Japanese' | 'Korean' | 'Norwegian' | 'Polish' | 'Portuguese' | 'Romanian' | 'Serbian' | 'Spanish' | 'Swedish' | 'Tagalog' | 'Vietnamese' required

The language in which the article will be written.

main_headings'auto' | 'h2_focus' | '3' | '4' | '5' | '6' | '7' | '8' | '9' | '10' required

The number of main headings (H2 headings) to be used in the article. Defaults to auto. (Optional)

target_word_countinteger

The target word count for the article. This option only applicable when main headings is set to auto or h2_focus. (Optional)

include_custom_instructionboolean

Option to include custom instructions for the article. Defaults to false. (Optional)

customize_outline_method'instruction' | 'fixed_template' | 'dynamic_template'

The method for customizing the outline. Defaults to instructions. (Optional)

customize_outline_instructionstring

Instructions for customizing the outline. (Optional)

Example request

{
  "article_title": "Can cat eat banana",
  "main_keyword": "Can cat eat banana",
  "region": "us",
  "output_language": "American English",
  "main_headings": "auto",
  "target_word_count": 500,
  "include_custom_instruction": true,
  "customize_outline_method": "fixed_template",
  "customize_outline_instruction": "1. Introduction \n2. Can Dogs Eat Bananas?\n- Nutritional benefits for dogs \n- Safe serving size for dogs \n- Potential risks for dogs \n3. Can Puppies Eat Bananas?\n- Special considerations for feeding bananas to puppies \n- Benefits for puppy development \n4. How to Feed Your Dog Bananas \n- Slicing and serving tips \n- Incorporating bananas into dog treats \n5. Conclusion and Recommendations \n- Moderation is key \n- Consult with your veterinarian \n- Other healthy fruit options for dogs"
}

Response

Successful response

statusstring

The status of the response

messagestring

A message related to the status

outlinestring

The generated outline for the article

all_outlinesstring[]

List of alternative outlines

Example response

{
  "status": "Success",
  "message": "Success",
  "outline": "1. Introduction\n2. Can Cats Eat Bananas?\n- Nutritional benefits for cats\n- Safe serving size for cats\n- Potential risks for cats\n3. Can Kittens Eat Bananas?\n- Special considerations for feeding bananas to kittens\n- Benefits for kitten development\n4. How to Feed Your Cat Bananas\n- Slicing and serving tips\n- Incorporating bananas into cat treats\n5. Conclusion and Recommendations\n- Moderation is key\n- Consult with your veterinarian\n- Other healthy fruit options for cats",
  "all_outlines": [
    "1. Introduction\n2. Can Cats Eat Bananas?\n- Nutritional benefits for cats\n- Safe serving size for cats\n- Potential risks for cats\n3. Can Kittens Eat Bananas?\n- Special considerations for feeding bananas to kittens\n- Benefits for kitten development\n4. How to Feed Your Cat Bananas\n- Slicing and serving tips\n- Incorporating bananas into cat treats\n5. Conclusion and Recommendations\n- Moderation is key\n- Consult with your veterinarian\n- Other healthy fruit options for cats",
    "1. Introduction \n2. Can Cats Eat Bananas?\n- Nutritional benefits for cats\n- Safe serving size for cats\n- Potential risks for cats\n3. Can Kittens Eat Bananas?\n- Special considerations for feeding bananas to kittens\n- Benefits for kitten development\n4. How to Feed Your Cat Bananas \n- Slicing and serving tips\n- Incorporating bananas into cat treats\n5. Conclusion and Recommendations \n- Moderation is key\n- Consult with your veterinarian\n- Other healthy fruit options for cats",
    "1. Introduction \n2. Can Cats Eat Bananas?\n- Nutritional benefits for cats \n- Safe serving size for cats \n- Potential risks for cats \n3. Can Kittens Eat Bananas?\n- Special considerations for feeding bananas to kittens \n- Benefits for kitten development \n4. How to Feed Your Cat Bananas \n- Slicing and serving tips \n- Incorporating bananas into cat treats \n5. Conclusion and Recommendations \n- Moderation is key \n- Consult with your veterinarian \n- Other healthy fruit options for cats"
  ]
}