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": "3c90c3cc-0d44-4b50-8888-8dd25736052a", "name": "<string>", "domain": "<string>", "relation": "SELF" }

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 unique identifier

​
name
string
required

Brand name

​
domain
string | null

Brand domain

​
relation
enum<string> | null

Brand relation to project

Available options:
SELF,
DIRECT_COMPETITOR,
OTHER,
IGNORED