curl --request GET \
--url https://server.promptwatch.com/api/v2/brand-book \
--header 'X-API-Key: <api-key>'import requests
url = "https://server.promptwatch.com/api/v2/brand-book"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://server.promptwatch.com/api/v2/brand-book', 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/brand-book",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://server.promptwatch.com/api/v2/brand-book"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.promptwatch.com/api/v2/brand-book")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/brand-book")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"projectId": "6ba7b81a-9dad-11d1-80b4-00c04fd430c8",
"slug": "example",
"name": "Example",
"website": "https://example.com",
"aliases": [
"Example Co"
],
"languageCode": "en-US",
"countryCode": "US",
"shortDescription": "A short summary of the brand",
"description": "A longer description of the brand",
"industry": "Advertising & Marketing",
"keyFeatures": [
"Fast setup"
],
"analysisInstructions": null
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "PROJECT_NOT_FOUND",
"message": "Project not found"
}{
"code": "PROJECT_NOT_FOUND",
"message": "Project not found"
}Get Brand Book
Brand book for this project: name, website, aliases, language, country, descriptions, industry, key features, and analysis instructions.
curl --request GET \
--url https://server.promptwatch.com/api/v2/brand-book \
--header 'X-API-Key: <api-key>'import requests
url = "https://server.promptwatch.com/api/v2/brand-book"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://server.promptwatch.com/api/v2/brand-book', 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/brand-book",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://server.promptwatch.com/api/v2/brand-book"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://server.promptwatch.com/api/v2/brand-book")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://server.promptwatch.com/api/v2/brand-book")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"projectId": "6ba7b81a-9dad-11d1-80b4-00c04fd430c8",
"slug": "example",
"name": "Example",
"website": "https://example.com",
"aliases": [
"Example Co"
],
"languageCode": "en-US",
"countryCode": "US",
"shortDescription": "A short summary of the brand",
"description": "A longer description of the brand",
"industry": "Advertising & Marketing",
"keyFeatures": [
"Fast setup"
],
"analysisInstructions": null
}{
"error": "Unauthorized",
"message": "Missing or invalid X-API-Key header."
}{
"code": "PROJECT_NOT_FOUND",
"message": "Project not found"
}{
"code": "PROJECT_NOT_FOUND",
"message": "Project not found"
}Authorizations
API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.
Response
Default Response
Project identifier
Project URL slug. Changes when the brand name changes.
Brand name
Brand website URL
Alternative names for the brand
Language code, for example en-US. Older projects may store a value outside the current list.
Country code, for example US. Older projects may store a value outside the current list.
Short summary of the brand
Longer description of the brand
Industry. null means Other. Older projects may store a value outside the current list.
Key features
How AI engines should describe the brand