---
title: "New Article Outline"
method: POST
path: "/v1/new-outline"
---

# New Article Outline

`POST /v1/new-outline`

Generate an outline for a new article. For more examples, visit [Example Payloads Documentation](https://apidocs.agilitywriter.ai/example-payloads.html).

## Query parameters

- `api_key` string, required

## Request body

- object
  - `article_title` string, required — The title of the article for which the outline is to be generated.
  - `main_keyword` string — 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_count` integer — The target word count for the article. This option only applicable when main headings is set to auto or h2_focus. (Optional)
  - `include_custom_instruction` boolean — 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_instruction` string — Instructions for customizing the outline. (Optional)

## Response `200`

Successful response

- object
  - `status` string — The status of the response
  - `message` string — A message related to the status
  - `outline` string — The generated outline for the article
  - `all_outlines` string[] — List of alternative outlines

## Other responses

- `400` — Invalid request
- `401` — Unauthorized

---

[API](https://skmtc.net/agilitywriter/apis/agility-writer-api-beta.md) · [All operations](https://skmtc.net/agilitywriter/apis/agility-writer-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/agilitywriter/agility-writer-api-beta/revisions/91fc72cb99f6/schema)