Create content

Create content

curl --request POST \
  --url https://server.promptwatch.com/api/v2/content/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "mode": "CREATE",
  "promptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contentGapRecommendationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customToneOfVoice": "<string>",
  "imagePromptInstructions": "<string>",
  "blockedWords": [
    "<string>"
  ],
  "briefTitle": "<string>",
  "briefDescription": "<string>",
  "briefObjective": "<string>",
  "briefCallToAction": "<string>",
  "briefKeyPoints": [
    "<string>"
  ],
  "briefContext": "<string>"
}
'

import requests

url = "https://server.promptwatch.com/api/v2/content/create"

payload = {
    "mode": "CREATE",
    "promptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contentGapRecommendationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customToneOfVoice": "<string>",
    "imagePromptInstructions": "<string>",
    "blockedWords": ["<string>"],
    "briefTitle": "<string>",
    "briefDescription": "<string>",
    "briefObjective": "<string>",
    "briefCallToAction": "<string>",
    "briefKeyPoints": ["<string>"],
    "briefContext": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mode: 'CREATE',
    promptId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    personaId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contentGapRecommendationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customToneOfVoice: '<string>',
    imagePromptInstructions: '<string>',
    blockedWords: ['<string>'],
    briefTitle: '<string>',
    briefDescription: '<string>',
    briefObjective: '<string>',
    briefCallToAction: '<string>',
    briefKeyPoints: ['<string>'],
    briefContext: '<string>'
  })
};

fetch('https://server.promptwatch.com/api/v2/content/create', 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://server.promptwatch.com/api/v2/content/create",
  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([
    'mode' => 'CREATE',
    'promptId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'personaId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contentGapRecommendationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customToneOfVoice' => '<string>',
    'imagePromptInstructions' => '<string>',
    'blockedWords' => [
        '<string>'
    ],
    'briefTitle' => '<string>',
    'briefDescription' => '<string>',
    'briefObjective' => '<string>',
    'briefCallToAction' => '<string>',
    'briefKeyPoints' => [
        '<string>'
    ],
    'briefContext' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://server.promptwatch.com/api/v2/content/create"

	payload := strings.NewReader("{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://server.promptwatch.com/api/v2/content/create")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v2/content/create")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}"

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

{
  "id": "6ba7b82c-9dad-11d1-80b4-00c04fd430c8",
  "status": "PENDING"
}

POST

content

create

Create content

curl --request POST \
  --url https://server.promptwatch.com/api/v2/content/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "mode": "CREATE",
  "promptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "contentGapRecommendationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "customToneOfVoice": "<string>",
  "imagePromptInstructions": "<string>",
  "blockedWords": [
    "<string>"
  ],
  "briefTitle": "<string>",
  "briefDescription": "<string>",
  "briefObjective": "<string>",
  "briefCallToAction": "<string>",
  "briefKeyPoints": [
    "<string>"
  ],
  "briefContext": "<string>"
}
'

import requests

url = "https://server.promptwatch.com/api/v2/content/create"

payload = {
    "mode": "CREATE",
    "promptId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "personaId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "contentGapRecommendationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "customToneOfVoice": "<string>",
    "imagePromptInstructions": "<string>",
    "blockedWords": ["<string>"],
    "briefTitle": "<string>",
    "briefDescription": "<string>",
    "briefObjective": "<string>",
    "briefCallToAction": "<string>",
    "briefKeyPoints": ["<string>"],
    "briefContext": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    mode: 'CREATE',
    promptId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    personaId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    contentGapRecommendationId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    customToneOfVoice: '<string>',
    imagePromptInstructions: '<string>',
    blockedWords: ['<string>'],
    briefTitle: '<string>',
    briefDescription: '<string>',
    briefObjective: '<string>',
    briefCallToAction: '<string>',
    briefKeyPoints: ['<string>'],
    briefContext: '<string>'
  })
};

fetch('https://server.promptwatch.com/api/v2/content/create', 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://server.promptwatch.com/api/v2/content/create",
  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([
    'mode' => 'CREATE',
    'promptId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'personaId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'contentGapRecommendationId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'customToneOfVoice' => '<string>',
    'imagePromptInstructions' => '<string>',
    'blockedWords' => [
        '<string>'
    ],
    'briefTitle' => '<string>',
    'briefDescription' => '<string>',
    'briefObjective' => '<string>',
    'briefCallToAction' => '<string>',
    'briefKeyPoints' => [
        '<string>'
    ],
    'briefContext' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$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://server.promptwatch.com/api/v2/content/create"

	payload := strings.NewReader("{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	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://server.promptwatch.com/api/v2/content/create")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.promptwatch.com/api/v2/content/create")

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

request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"mode\": \"CREATE\",\n  \"promptId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"personaId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"contentGapRecommendationId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"customToneOfVoice\": \"<string>\",\n  \"imagePromptInstructions\": \"<string>\",\n  \"blockedWords\": [\n    \"<string>\"\n  ],\n  \"briefTitle\": \"<string>\",\n  \"briefDescription\": \"<string>\",\n  \"briefObjective\": \"<string>\",\n  \"briefCallToAction\": \"<string>\",\n  \"briefKeyPoints\": [\n    \"<string>\"\n  ],\n  \"briefContext\": \"<string>\"\n}"

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

{
  "id": "6ba7b82c-9dad-11d1-80b4-00c04fd430c8",
  "status": "PENDING"
}

Authorizations

X-API-Key

string

header

required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Body

application/json

Option 1
Option 2

mode

enum<string>

required

Create new content from a prompt (not optimizing an existing page).

Available options:

CREATE

promptId

string<uuid>

required

LLM prompt to anchor generation on (list via GET /prompts).

personaId

string<uuid>

required

Persona for voice and audience (list via GET /personas).

type

enum<string>

required

Output format. Supports article/blog formats plus on-site citation-aligned formats such as HOW_TO, REVIEW, COMPARISON, CASE_STUDY, DOCUMENTATION, WIKI, PRODUCT_PAGE, LANDING_PAGE, and PRESS_RELEASE.

Available options:

ARTICLE,

BLOG_POST,

OPINION,

LISTICLE,

HOW_TO,

REVIEW,

COMPARISON,

CASE_STUDY,

INTERVIEW,

DOCUMENTATION,

WIKI,

PRODUCT_PAGE,

LANDING_PAGE,

PRESS_RELEASE,

GENERIC_CONTENT,

PRODUCT_COMPARISON

contentLength

enum<string>

required

Target length. SHORT ≈ 200–500 words; MEDIUM ≈ 500–1,000; LONG ≈ 1,000–3,000.

Available options:

SHORT,

MEDIUM,

LONG

contentGapRecommendationId

string<uuid>

Optional recommendation from GET /content-gap/prompts/:promptId/latest/recommendations.

toneOfVoice

enum<string>

Tone override; if omitted, the project default is used. CUSTOM requires customToneOfVoice.

Available options:

PROFESSIONAL,

CASUAL,

TECHNICAL,

CONVERSATIONAL,

NEUTRAL,

AUTHORITATIVE,

FRIENDLY,

PERSUASIVE,

FORMAL,

WITTY,

CUSTOM

customToneOfVoice

string

Required when toneOfVoice is CUSTOM; ignored otherwise.

languageCode

enum<string>

BCP-47 language code from the supported enum (e.g. "en-US", "es-ES"). Overrides the project default. Omit to use the project default or en-US.

Available options:

en-US,

en-GB,

en-IN,

en-AU,

en-CA,

en-NZ,

nl-NL,

nl-BE,

es-ES,

es-MX,

es-AR,

es-CO,

es-CL,

es-PE,

es-VE,

ca-ES,

fr-FR,

fr-BE,

fr-CA,

de-DE,

de-AT,

de-CH,

cs-CZ,

sk-SK,

no-NO,

sv-SE,

da-DK,

it-IT,

fi-FI,

pl-PL,

hu-HU,

ro-RO,

lt-LT,

lv-LV,

uk-UA,

el-GR,

tr-TR,

ar-SA,

ar-EG,

ar-AE,

he-IL,

pt-PT,

pt-BR,

ja-JP,

id-ID,

vi-VN,

th-TH,

km-KH,

en-KH,

ko-KR,

hi-IN,

ru-RU,

kk-KZ,

ms-MY,

fil-PH,

zh-SG,

zh-TW,

zh-HK

imageArtisticStyle

enum<string> | null

Visual style for AI-generated featured images when the generate-article-image tool is enabled. Null inherits the project default.

Available options:

photo-realistic,

flat-illustration,

watercolor,

3d-render,

minimalist,

isometric,

editorial,

abstract

imagePromptInstructions

string | null

Additional instructions for the image generator (max 200 chars). Null inherits the project default.

Maximum string length: 200

blockedWords

string[]

Words or phrases the generated content must not contain. Overrides the project's default blocked-words list.

briefTitle

string

Exact title for the generated document. When provided, the AI uses this string verbatim as the document title (max 150 chars).

Maximum string length: 150

briefDescription

string

Exact meta description for the generated document. When provided, the AI uses this string verbatim (max 250 chars).

Maximum string length: 250

briefObjective

string

Goal or purpose of the content piece — guides the AI on what the article should achieve (max 500 chars).

Maximum string length: 500

briefCallToAction

string

Desired call-to-action the content should drive (e.g. "Sign up for a free trial") (max 300 chars).

Maximum string length: 300

briefKeyPoints

string[]

Key points the article must cover. Each item is a short instruction for the AI writer (max 10 items).

Maximum array length: 10

Maximum string length: 200

briefContext

string

Additional context or background for the writer — e.g. target audience nuances, tone guidance, competitor positioning (max 500 chars).

Maximum string length: 500

Response

Default Response

string<uuid>

required

Document id; poll GET /content/:id until terminal status.

status

enum<string>

required

Always PENDING immediately after enqueue; use GET /content/:id for updates.

Available options:

PENDING

List content Get content by id

⌘I

Overview

API Reference

Changelog

Authorizations

Body

Response