Create Article

post https://api.byword.ai/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.

Body Params

key

string

required

Defaults to [API_KEY]

Replace with your Byword API key (https://byword.ai/integrations_api).

mode

string

required

Defaults to title

Tell Byword whether your 'input' is a keyword (from which Byword will generate a title) or if it's a title (and Byword should use it without modification)

input

string

required

Defaults to The Best Cities to Visit in Italy

The keyword or title that you'd like to base your article on (depending on what you have selected for 'mode').

language

string

Defaults to English

The language that you're generating in; defaults to English.

subheadings

string

Defaults to Rome;Venice;Naples;Florence;Other Cities To Visit

[Only provide this parameter if you're using 'title' mode] When using 'title' mode, you can optionally choose to provide a list of between 4 and 20 (inclusive) subheadings, which Byword will use to write the article from. All the values you pass here will appear exactly as your H2s in your final article. This parameter should be formatted as a semi-colon-separated string (e.g. "string1;string2;string3")

prompts

string

Defaults to focus on cities in northern italy; provide recommendations for the best restaurants in each city too

A semi-colon-separated string of custom prompts (https://learn.byword.ai/getting-started/article-settings/custom-prompts). You can provide 0 to 3 custom prompts (inclusive) where each custom prompt is 160 characters maximum. The value of this should looks like "custom prompt 1; custom prompt 2" (without quotes).

undetectable

boolean

Defaults to false

Whether you'd like Byword to write in a way that aims to bypass AI writing detectors

tone

string

Defaults to Neutral

An (ideally one-word) adjective used to describe the tone you'd like Byword to write in (e.g. 'engaging', 'professional', or 'playful'). To use Byword's default tone of voice, you can either skip this parameter, or pass 'Neutral'.

length

int32

Defaults to 1500

The target wordcount that you'd like Byword to aim for. Defaults to 1500 if not provided.

style

string

The ID of a custom style, retrieved via the 'List Styles' endpoint.

Response

200200