Update Content Agent settings
curl --request PUT \
--url https://server.promptwatch.com/api/v2/content-agent/settings \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enabled": true,
"blackoutDates": [
"<string>"
],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://server.promptwatch.com/api/v2/content-agent/settings"
payload = {
"enabled": True,
"blackoutDates": ["<string>"],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
blackoutDates: ['<string>'],
scheduleTimezone: '<string>',
maxPerDay: 10,
budgetPercentage: 0.5,
defaultEnabledTools: [],
cmsConnectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://server.promptwatch.com/api/v2/content-agent/settings', 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-agent/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'blackoutDates' => [
'<string>'
],
'scheduleTimezone' => '<string>',
'maxPerDay' => 10,
'budgetPercentage' => 0.5,
'defaultEnabledTools' => [
],
'cmsConnectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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-agent/settings"
payload := strings.NewReader("{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://server.promptwatch.com/api/v2/content-agent/settings")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/content-agent/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"setupCompletedAt": "2023-11-07T05:31:56Z",
"publishWindows": {
"days": [
{
"weekday": 3,
"startMinute": 712,
"endMinute": 727
}
]
},
"blackoutDates": [
"<string>"
],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}Content Agent
Update Content Agent settings
Updates the project’s Content Agent configuration. Requires the org Content Agent entitlement and that setup was completed in the dashboard (setupCompletedAt).
PUT
/
content-agent
/
settings
Update Content Agent settings
curl --request PUT \
--url https://server.promptwatch.com/api/v2/content-agent/settings \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"enabled": true,
"blackoutDates": [
"<string>"
],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://server.promptwatch.com/api/v2/content-agent/settings"
payload = {
"enabled": True,
"blackoutDates": ["<string>"],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
blackoutDates: ['<string>'],
scheduleTimezone: '<string>',
maxPerDay: 10,
budgetPercentage: 0.5,
defaultEnabledTools: [],
cmsConnectionId: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://server.promptwatch.com/api/v2/content-agent/settings', 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-agent/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'blackoutDates' => [
'<string>'
],
'scheduleTimezone' => '<string>',
'maxPerDay' => 10,
'budgetPercentage' => 0.5,
'defaultEnabledTools' => [
],
'cmsConnectionId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
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-agent/settings"
payload := strings.NewReader("{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://server.promptwatch.com/api/v2/content-agent/settings")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/content-agent/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"blackoutDates\": [\n \"<string>\"\n ],\n \"scheduleTimezone\": \"<string>\",\n \"maxPerDay\": 10,\n \"budgetPercentage\": 0.5,\n \"defaultEnabledTools\": [],\n \"cmsConnectionId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"settings": {
"enabled": true,
"setupCompletedAt": "2023-11-07T05:31:56Z",
"publishWindows": {
"days": [
{
"weekday": 3,
"startMinute": 712,
"endMinute": 727
}
]
},
"blackoutDates": [
"<string>"
],
"scheduleTimezone": "<string>",
"maxPerDay": 10,
"budgetPercentage": 0.5,
"defaultEnabledTools": [],
"cmsConnectionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}{
"code": "CONTENT_AUTOMATION_SLOT_NOT_FOUND",
"message": "Content piece not found"
}Authorizations
API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.
Body
application/json
Pause or re-enable the agent. Requires setup to be completed.
Available options:
GATED, AUTOMATE Available options:
LIVE, DRAFT Available options:
AT_SLOT, IMMEDIATE_ON_APPROVAL Allowed publish windows per weekday, in minutes from local midnight in scheduleTimezone.
Show child attributes
Show child attributes
IANA timezone; null clears to org default.
Required range:
1 <= x <= 20Required range:
0 <= x <= 1Available options:
GOOGLE_SEARCH, GOOGLE_NEWS_SEARCH, CRAWL_WEBSITE, ANALYZE_COMPETITOR_PAGE, GENERATE_ARTICLE_IMAGE, FIND_INTERNAL_LINKS, TAKE_SCREENSHOT, SEARCH_KNOWLEDGE_BASE Response
Default Response
Project Content Agent settings. Null when setup has never been completed.
Show child attributes
Show child attributes
⌘I