Create Article

curl --request POST \
  --url https://byword.ai/create_article \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "mode": "<string>",
  "key": "<string>",
  "domain": "<string>"
}
'

import requests

url = "https://byword.ai/create_article"

payload = {
    "input": "<string>",
    "mode": "<string>",
    "key": "<string>",
    "domain": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({input: '<string>', mode: '<string>', key: '<string>', domain: '<string>'})
};

fetch('https://byword.ai/create_article', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://byword.ai/create_article",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => '<string>',
    'mode' => '<string>',
    'key' => '<string>',
    'domain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://byword.ai/create_article"

	payload := strings.NewReader("{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://byword.ai/create_article")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://byword.ai/create_article")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "articleID": "<string>"
}

POST

create_article

Create Article

curl --request POST \
  --url https://byword.ai/create_article \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": "<string>",
  "mode": "<string>",
  "key": "<string>",
  "domain": "<string>"
}
'

import requests

url = "https://byword.ai/create_article"

payload = {
    "input": "<string>",
    "mode": "<string>",
    "key": "<string>",
    "domain": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({input: '<string>', mode: '<string>', key: '<string>', domain: '<string>'})
};

fetch('https://byword.ai/create_article', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://byword.ai/create_article",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'input' => '<string>',
    'mode' => '<string>',
    'key' => '<string>',
    'domain' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://byword.ai/create_article"

	payload := strings.NewReader("{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://byword.ai/create_article")
  .header("Content-Type", "application/json")
  .body("{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://byword.ai/create_article")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"input\": \"<string>\",\n  \"mode\": \"<string>\",\n  \"key\": \"<string>\",\n  \"domain\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "articleID": "<string>"
}

This endpoint creates a new article based on your domain-specific settings. The article content is generated using parameters defined in your domain configuration, such as language, tone, length, and other customizations.

Request

string

required

The primary content input based on your selected mode:

For “keyword” mode: The keyword to base the article on
For “title” mode: The article title

string

required

Specifies the generation mode. Possible values:

keyword: Generate an article based on a keyword
title: Generate an article based on a title

string

required

Your API key for authentication

string

required

The domain name (e.g., “example.com”) to use for article settings. Must be a domain associated with your account.

Response

string

A status message indicating success or failure

string

The ID of the created article (returned only on success)

How It Works

The API validates your API key and checks if you have sufficient article credits
It verifies that the specified domain exists and is associated with your account
It retrieves domain-specific settings including:
- Language
- Tone of voice
- Custom formatting
- Target length
- Sitemap
- Undetectable settings
- Custom prompts
It generates an article based on these settings and your input

Domain Settings

All article parameters are taken from your domain settings, including:

Language: The article’s language (defaults to English if not specified)
Tone: Writing style tone from domain settings
Format: Custom formatting style defined in domain settings
Target Length: Word count target for the article
Undetectable: Whether to optimize for AI detection avoidance
Prompts: Custom generation prompts defined in domain settings
Sitemap: Domain sitemap for content optimization

Examples

Request Example

{
  "input": "sustainable gardening",
  "mode": "keyword",
  "key": "your_api_key_here",
  "domain": "example.com"
}

Success Response

{
  "message": "Article successfully created",
  "articleID": "1234567890abcdef"
}

Error Response

{
  "message": "The domain you specified does not belong to this user"
}

Error Messages

Error Message	Description
”Please supply an input parameter”	The required `input` parameter is missing
”Please supply a mode parameter”	The required `mode` parameter is missing
”Please supply an API key”	The required `key` parameter is missing
”Please supply a domain parameter”	The required `domain` parameter is missing
”Please check the API key you’re using, and try again”	Invalid API key
”The user with this API key associated does not have any article credits remaining”	No article credits left
”This user does not have any domains associated with their account”	No domains configured for this user
”The domain you specified does not belong to this user”	Domain name not associated with user account
”Please wait for your Unlimited account to be setup fully before calling the API”	Account setup is pending
”Please ensure you’ve added your OpenAI token to https://byword.ai/unlimited, before calling this endpoint”	Missing OpenAI token for Unlimited accounts
”Please ensure you’ve added your Replicate token to https://byword.ai/unlimited, before calling this endpoint”	Missing Replicate token for Unlimited accounts

Get Started

The Basics

Programmatic

Advanced Features

Create Article

Request

Response

How It Works

Domain Settings

Examples

Request Example

Success Response

Error Response

Error Messages

​Request

​Response

​How It Works

​Domain Settings

​Examples

​Request Example

​Success Response

​Error Response

​Error Messages

Request

Response

How It Works

Domain Settings

Examples

Request Example

Success Response

Error Response

Error Messages