Log In

Create Article

This endpoint starts the article creation process in Byword. It effectively allows for three different modes of article creation, just like in the Byword app. Please refer to the Getting Started page for more details.

These three different modes can be achieved as follows:

  • Keyword
    Set mode to keyword and supply a keyword as your input parameter.
  • Article Title
    Set mode to title and supply an article title as your input parameter.
  • Article Title + Subheadings
    Set mode to title and supply an article title as your input parameter, along with a semi-colon-separated list of subheadings as your subheadings parameter.

Successful API calls will return a success message, and an article ID. You can then poll the Get Article endpoint to check the status of the article, and retrieve all its fields once ready. Articles typically take around 60 seconds to generate, but can take longer in certain circumstances.

Language