Skip to main content
GET
Get Brand Book

Authorizations

X-API-Key
string
header
required

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

Response

Default Response

projectId
string<uuid>
required

Project identifier

slug
string
required

Project URL slug. Changes when the brand name changes.

name
string
required

Brand name

website
string
required

Brand website URL

aliases
string[]
required

Alternative names for the brand

languageCode
string | null
required

Language code, for example en-US. Older projects may store a value outside the current list.

countryCode
string | null
required

Country code, for example US. Older projects may store a value outside the current list.

shortDescription
string | null
required

Short summary of the brand

description
string | null
required

Longer description of the brand

industry
string | null
required

Industry. null means Other. Older projects may store a value outside the current list.

keyFeatures
string[]
required

Key features

analysisInstructions
string | null
required

How AI engines should describe the brand