Skip to main content
POST
/
brands
Create Brand
curl --request POST \
  --url https://server.promptwatch.com/api/v2/brands \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "relation": "SELF"
}
'
{ "id": "6ba7b81c-9dad-11d1-80b4-00c04fd430c8", "name": "Contoso Insights", "domain": "contoso.example", "relation": "DIRECT_COMPETITOR" }

Authorizations

​
X-API-Key
string
header
required

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

Body

application/json
​
name
string
required

Brand name

Minimum string length: 1
​
url
string
required

Brand website URL

​
relation
enum<string>
required

Brand relation to project

Available options:
SELF,
DIRECT_COMPETITOR,
OTHER,
IGNORED

Response

Default Response

​
id
string<uuid>
required

Brand identifier

​
name
string
required

Brand name

​
domain
string | null

Brand hostname when known (e.g. example.com).

​
relation
enum<string> | null

Brand relation to project

Available options:
SELF,
DIRECT_COMPETITOR,
OTHER,
IGNORED