> ## Documentation Index
> Fetch the complete documentation index at: https://promptwatch.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Brand

> Create or connect a brand to the project.



## OpenAPI

````yaml /v2/openapi.json post /brands
openapi: 3.0.0
info:
  title: Promptwatch API v2
  description: >-
    API v2 for customer integrations with Promptwatch monitoring platform. This
    version provides improved structure, additional endpoints, and enhanced
    functionality.
  version: 2.0.0
  contact:
    name: Promptwatch Support
    email: team@promptwatch.com
    url: https://promptwatch.com
  license:
    name: Commercial
    url: https://promptwatch.com/terms-and-conditions
servers:
  - url: https://server.promptwatch.com/api/v2
    description: Promptwatch API v2
security: []
tags:
  - name: Authentication
    description: API key validation and authentication
  - name: Content
    description: >-
      AI content generation and optimization. Create content asynchronously and
      poll for results.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Models
    description: Available LLM models
  - name: Monitors
    description: Monitor management and CRUD operations
  - name: Page Tracker
    description: Track URLs and inspect citation stats, responses, and prompts
  - name: Prompts
    description: Prompt management and operations
  - name: Query Fanouts
    description: ChatGPT query fanout keywords
  - name: Responses
    description: LLM response data and analytics
  - name: Tags
    description: Tag management for prompts
  - name: Topics
    description: Topic management for prompts
  - name: Actions
    description: Action items (GEO suggestions and tasks)
  - name: Personas
    description: Persona configuration for monitors
  - name: Brands
    description: Brand management for competitive analysis
  - name: Visibility
    description: Brand visibility time series and competitor heatmaps
  - name: Citations
    description: Citation analytics from AI responses
  - name: Analytics
    description: Visitor analytics, AI crawler logs, sentiment, and brand visibility trends
  - name: Projects
    description: Project management (organization-level keys only)
  - name: Sitemap
    description: Sitemap crawl progress and discovered URLs
  - name: Site Health
    description: >-
      Crawled pages with SEO issues (titles, meta descriptions, H1, thin
      content)
  - name: Socials
    description: >-
      Social media citations (Reddit posts and YouTube videos) found in LLM
      responses
paths:
  /brands:
    post:
      tags:
        - Brands
      summary: Create Brand
      description: Create or connect a brand to the project.
      operationId: createBrand
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: Brand name
                url:
                  type: string
                  description: Brand website URL
                relation:
                  type: string
                  enum:
                    - SELF
                    - DIRECT_COMPETITOR
                    - OTHER
                    - IGNORED
                  description: Brand relation to project
              required:
                - name
                - url
                - relation
              additionalProperties: false
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 6ba7b81c-9dad-11d1-80b4-00c04fd430c8
                  name: Contoso Insights
                  domain: contoso.example
                  relation: DIRECT_COMPETITOR
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Brand identifier
                  name:
                    type: string
                    description: Brand name
                  domain:
                    type: string
                    nullable: true
                    description: Brand hostname when known (e.g. example.com).
                  relation:
                    type: string
                    enum:
                      - SELF
                      - DIRECT_COMPETITOR
                      - OTHER
                      - IGNORED
                    nullable: true
                    description: Brand relation to project
                required:
                  - id
                  - name
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: BRAND_NOT_FOUND
                  message: Brand not found
                properties:
                  code:
                    type: string
                    description: Domain error code
                    enum:
                      - BRAND_NOT_FOUND
                      - BRAND_ALREADY_EXISTS
                      - BRAND_INVALID_NAME
                      - INTERNAL_ERROR
                    example: BRAND_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Brand not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: BRAND_NOT_FOUND
                    message: Brand not found
                example2:
                  value:
                    code: BRAND_ALREADY_EXISTS
                    message: Brand is already connected to the project
                example3:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
        '401':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Unauthorized
                  message: Missing or invalid X-API-Key header.
                properties:
                  error:
                    type: string
                    description: Error category (often aligned with HTTP semantics)
                  code:
                    type: string
                    description: Optional machine-readable code
                  message:
                    type: string
                    description: Human-readable explanation
                  details:
                    type: object
                    description: Optional structured detail (e.g. validation)
                    additionalProperties: true
                required:
                  - error
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: BRAND_NOT_FOUND
                  message: Brand not found
                properties:
                  code:
                    type: string
                    description: Domain error code
                    enum:
                      - BRAND_NOT_FOUND
                      - BRAND_ALREADY_EXISTS
                      - BRAND_INVALID_NAME
                      - INTERNAL_ERROR
                    example: BRAND_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                    example: Brand not found
                required:
                  - code
                  - message
                additionalProperties: false
              examples:
                example1:
                  value:
                    code: BRAND_NOT_FOUND
                    message: Brand not found
                example2:
                  value:
                    code: BRAND_ALREADY_EXISTS
                    message: Brand is already connected to the project
                example3:
                  value:
                    code: INTERNAL_ERROR
                    message: An unexpected error occurred
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: >-
        API key for authentication. Get yours from the Promptwatch dashboard
        under Settings > API Keys.

````