Sign in
latestOpenAPI 3.0.02026-08-08100184.9 KB

91fc72cb99f6

New Business Webpage

Submit a request to write content for business website pages. For more examples, visit Example Payloads Documentation.

post/v1/new-webpage

Query parameters

api_keystring required

API key for authentication

Request body

article_titlestring required

The title of the article. If left empty, ensure that the main keyword is provided.

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.

project_idinteger

The ID of the project to which the article belongs. Defaults to 0 (none). (Optional)

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.

article_length'auto' | 'h2_focus' | '750' | '751_1250' | '1251_2000' | '2001_3000' | '3001_4000' | '4001_5000' required

The article length for the article. Defaults to auto.

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

Deprecated - Use article_length. 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)

article_structure'advanced_standard' | 'advanced_detail' | 'text_standard' | 'text_long'

The structure of the content for each heading. Defaults to advanced_standard. (Optional)

ai_model'standard' | 'gpt4o_mini' | 'gpt4o' | 'gpt4.1' | 'gpt4.1_mini' | 'gpt5' | 'gpt5_mini' | 'gpt5.2' | 'o3_mini' | 'o4_mini' | 'claude4_sonnet' | 'claude4.5_sonnet' | 'claude4.6_sonnet' | 'deepseek_v3' | 'grok3' | 'grok3_mini' | 'grok4' | 'gemini_pro_2.5' | 'gemini_pro_3.1' | 'gemini_flash_2.0' required

The AI model to be used for generating the article. Defaults to standard. (Optional)

factual_data'none' | 'custom' | 'indepth_research' | 'indepth_research_cite' | 'standard'

The level of factual data to be included in the article. Defaults to custom. (Optional)

factual_data_custom_urlstring

Only applicable when factual_data is set to custom. Provide the factual data sources (maximum of 3 URLs) for the article, with each URL on a new line. If left empty, the system will automatically select 3 URLs from the top search results. If none of the URLs are accessible, the writing job will be canceled. (Optional)

audiencestring

The target audience for the article. (Optional)

tone_of_voicestring

The tone of voice to be used in the article. (Optional)

point_of_view'point_of_view_auto' | 'first_person_singular' | 'first_person_plural' | 'second_person' | 'third_person'

The point of view to be used in the article. Defaults to point_of_view_auto. (Optional)

writing_style'default' | 'auto_from_serp' | 'all_authoritative_conversational' | 'all_authoritative_instructional' | 'all_expository_technical' | 'all_humanize' | 'all_precision_optimization' | 'all_precision_semantic_triples' | 'all_unfluffpro_1_authoritative' | 'all_unfluffpro_2_authoritative' | 'health_authoritative' | 'local_biz_authoritative_persuasion' | 'news' | 'seo_nlp_friendly' | 'seo_authoritative' | 'travel_narrative' | 'anti_ai_detection_concise_tone' | 'anti_ai_detection_informal_tone'

The writing style to be used in the article. Defaults to default. (Optional)

introduction_style'concise' | 'engaging' | 'authoritative' | 'comprehensive_insight'

The style of the introduction. Defaults to concise. (Optional)

conclusion_style'concise' | 'engaging' | 'expert_opinion'

The style of the conclusion. Defaults to concise. (Optional)

business_namestring required

The name of the business for which the article is being created.

type_of_businessstring required

The type of business for which the article is being created.

custom_knowledgestring

Custom knowledge/Background info to be included in the article. Do not include writing instruction. (Optional)

create_outlineboolean

Option to create an outline for the article. Defaults to false. (Optional)

article_outlinestring

The outline of the article. If empty, an outline will be auto-generated.

include_custom_instructionboolean

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

customize_outline_method'instructions' | 'fixed_template' | 'dynamic_template'

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

customize_outline_instructionstring

Instructions for customizing the outline. (Optional)

writing_instruction_for_headingstring

Writing instructions for all headings. (Optional)

keywordsstring

List of keywords to be included in the article. Each keyword should be on a new line. (Optional)

key_takeawaysboolean

Option to generate key takeaways for the article. Defaults to true. (Optional)

faqs_title_descriptionboolean

Option to generate FAQs, meta title, and description for the article. Defaults to true. (Optional)

image_promptsboolean

Option to generate image prompts for the article. Defaults to false. (Optional)

youtube_videosboolean

Option to include relevant YouTube videos in the article. Defaults to false. (Optional)

add_stylingboolean

Option to add bold formatting style to the article. Defaults to false. (Optional)

readability_level'default' | '5th_grade' | '6th_grade' | '7th_grade' | '8th_9th_grade' | '10th_12th_grade' | '13th_15th_grade' | '16th_grade'

This option enhances the article's readability. Defaults to default. (Optional)

improve_readabilityboolean

Deprecated - Use readability_level. This option enhances the article's readability but will be ignored if readability_level is specified. Defaults to true. (Optional)

authority_linksboolean

Option to include authority links in the article. Defaults to false. (Optional)

internal_linksboolean

Option to include internal links in the article. Defaults to false. (Optional)

internal_links_referencesstring

A list of internal link references to be incorporated into the article. Each link should be on a new line. (Optional)

entity_enrichmentboolean

Option to include entities from top-ranking sites in the article. Defaults to true. (Optional)

change_h3_to_boldboolean

Option to change H3 headings to bold in the article. Defaults to false. (Optional)

disable_transitionboolean

Option to exclude transition words between each heading. Defaults to true. (Optional)

exclude_quotesboolean

Option to exclude quotes in the article. Defaults to true. (Optional)

negative_termsboolean

Option to remove negative terms from the article. Defaults to false. (Optional)

negative_terms_referencesstring

A list of negative terms to be removed from the article. If left empty, common negative terms will be used. (Optional)

first_hand_experienceboolean

Option to include first-hand experience in the article. Defaults to false. (Optional)

shoutout_postsboolean

Option to generate shoutout posts from the article. Defaults to false. (Optional)

images_placement'none' | 'free' | 'standard_20' | 'standard_40' | 'standard_60' | 'premium_6' | 'premium_13' | 'premium_19'

Option to include number of images in the article. Defaults to none. (Optional)

images_style'photo' | 'cinematic' | 'creative_photo' | 'anime' | 'comic_book' | 'digital_art' | 'fantasy_art' | 'flat_design'

The style of images to be included in the article. Defaults to photo. (Optional)

images_size'landscape_16_9' | 'landscape_3_2' | 'portrait_9_16' | 'square' | 'landscape_16_9_small' | 'landscape_3_2_small' | 'portrait_9_16_small' | 'square_small'

The size of images to be included in the article. Defaults to landscape_3_2. (Optional)

images_alt_tag'none' | 'short' | 'long' | 'short_keyword' | 'long_keyword'

The alt tag for images included in the article. Defaults to short. (Optional)

images_text_overlay'none' | '1_none' | '1_black' | '1_blue' | '1_green' | '1_red' | '2_none' | '2_black' | '2_blue' | '2_green' | '2_red'

The number of text overlay images included in the article. Defaults to none. (Optional)

images_no_people'auto' | 'less' | 'more' | 'none'

The presence of people in the images included in the article. Defaults to auto. (Optional)

images_ethnicity'auto' | 'black' | 'caucasian' | 'east_asian' | 'south_asian' | 'hispanic'

The ethnicity of people in the images included in the article. Defaults to auto. (Optional)

images_same_person'no' | 'yes'

Option to use the same person in all images included in the article. Defaults to no. (Optional)

publish_tostring

The URL of the site where the article will be published. This URL must match the site specified in the Agility Writer WordPress integration. If left empty, the system will not auto-publish the article. (Optional)

publish_type'post' | 'page'

The type of publication (post or page). Defaults to post. (Optional)

publish_status'draft' | 'publish'

The status of the publication (draft or publish). Defaults to draft. (Optional)

publish_datestring date-time

The publish date of the article. Defaults to current date time. (Optional)

publish_category_idinteger

The category ID for the publication. (Optional)

publish_slug_type'default' | 'keyword' | 'title'

The type of slug for the publication. (Optional)

publish_tagsstring

The tags for the publication. (Optional)

nw_api_keystring

The API key for NeuronWriter. (Optional)

nw_query_idstring

The query ID for NeuronWriter. (Optional)

nw_project_idstring

The project ID for NeuronWriter. (Optional)

nw_word_countinteger

The word count from NeuronWriter. (Optional)

nw_to_content_editorboolean

Option to auto-push the article to NeuronWriter once completed. Defaults to false. (Optional)

Example request

{
  "article_title": "Top Locksmiths In Melbourne - 247 Pro Locksmith",
  "main_keyword": "Locksmiths In Melbourne",
  "region": "au",
  "output_language": "Australian English",
  "article_length": "auto",
  "main_headings": "auto",
  "target_word_count": 1500,
  "article_structure": "advanced_standard",
  "ai_model": "standard",
  "factual_data": "custom",
  "audience": "Homeowner",
  "tone_of_voice": "Casual",
  "point_of_view": "point_of_view_auto",
  "writing_style": "all_precision_semantic_triples",
  "introduction_style": "concise",
  "conclusion_style": "concise",
  "business_name": "247 Pro Locksmith",
  "type_of_business": "Locksmith in Melbourne",
  "custom_knowledge": "We founded 247 Pro Locksmith in Melbourne, Australia, in 2010. Our goal was simple...",
  "create_outline": true,
  "include_custom_instruction": true,
  "customize_outline_method": "instructions",
  "keywords": "Keyword 1\nKeyword 2\nKeyword 3",
  "key_takeaways": true,
  "faqs_title_description": true,
  "readability_level": "default",
  "improve_readability": true,
  "internal_links_references": "https://aiseoarticle.com/url-1/\nhttps://aiseoarticle.com/url-2/",
  "entity_enrichment": true,
  "disable_transition": true,
  "exclude_quotes": true,
  "negative_terms_references": "believe it or not, trust us, buckle up, in additional, additionally, navigating, when it comes to, embarking",
  "images_placement": "free",
  "images_style": "photo",
  "images_size": "landscape_3_2",
  "images_alt_tag": "none",
  "images_text_overlay": "none",
  "images_no_people": "auto",
  "images_ethnicity": "auto",
  "images_same_person": "no",
  "publish_to": "https://aiseoarticle.com",
  "publish_type": "post",
  "publish_status": "draft",
  "publish_date": "2024-07-08 10:10",
  "publish_slug_type": "default",
  "publish_tags": "tag 1, tag 2, tag 3",
  "nw_word_count": 500
}

Response

Successful response

statusstring

The status of the response.

article_idinteger

The ID of the created article.

messagestring

The message related to the status.

Example response

{
  "status": "Success",
  "article_id": 6118,
  "message": "Your request has been added to the writing queue"
}