> ## 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.

# Set Up Project

> Create a project, enrich it from its website, and create up to 3 monitors with generated prompts (50 total) in one synchronous call. This can take 1-2 minutes. Requires an organization-level API key; X-Project-Id is not required.



## OpenAPI

````yaml /v2/openapi.json post /projects/setup
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 Agent
    description: >-
      Content Agent (automated content) lifecycle: project settings, scheduled
      slots, review (accept/decline), and publish.
  - name: Content Gap
    description: Content gap analysis and recommendations
  - name: Publishing
    description: >-
      Publish content to a connected CMS, or record a live URL, and track the
      published page
  - 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: Events
    description: >-
      Dated project events such as prompts added and actions completed, for
      annotating time series
  - 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: Usage
    description: Plan usage and limits (organization-level keys only)
  - name: Sitemap
    description: Sitemap feeds, crawler settings, 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
  - name: Ads Radar
    description: Sponsored ads captured in AI answers
  - name: Shopping
    description: Product appearances in AI shopping answers and tracked products
paths:
  /projects/setup:
    post:
      tags:
        - Projects
      summary: Set Up Project
      description: >-
        Create a project, enrich it from its website, and create up to 3
        monitors with generated prompts (50 total) in one synchronous call. This
        can take 1-2 minutes. Requires an organization-level API key;
        X-Project-Id is not required.
      operationId: setupProject
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                  description: Project name
                website:
                  type: string
                  description: Project website URL
                countryCode:
                  type: string
                  description: Country code (e.g., US)
                languageCode:
                  type: string
                  description: Language code (e.g., en)
                monitors:
                  type: array
                  minItems: 1
                  maxItems: 3
                  items:
                    type: object
                    additionalProperties: false
                    required:
                      - prompts
                    properties:
                      prompts:
                        type: integer
                        minimum: 1
                        maximum: 50
                        description: Number of prompts to generate for this monitor (1-50)
                      type:
                        type: string
                        enum:
                          - ORGANIC
                          - BRAND_SPECIFIC
                          - COMPETITOR_COMPARISON
                        description: Optional prompt type bias; omit for a mixed set
                      name:
                        type: string
                        description: Optional monitor name; defaults to '{project} Monitor'
                      models:
                        type: array
                        items:
                          type: string
                        description: >-
                          Optional model IDs; defaults to gpt-search, sonar-pro,
                          and google-ai-overview, filtered to the plan
                  description: >-
                    Optional monitors to create (max 3, 50 prompts total). Omit
                    for one monitor with 10 mixed prompts.
              required:
                - name
                - website
              additionalProperties: false
      responses:
        '201':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  id: 6ba7b81a-9dad-11d1-80b4-00c04fd430c8
                  name: Acme
                  slug: acme
                  website: https://acme.com
                  createdAt: '2026-09-16T09:12:00.000Z'
                  monitors:
                    - id: 0f1e2d3c-4b5a-6978-8796-a5b4c3d2e1f0
                      name: Acme Monitor
                      type: null
                      models:
                        - gpt-search
                        - sonar-pro
                        - google-ai-overview
                      promptCount: 10
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Project unique identifier
                  name:
                    type: string
                    description: Project name
                  slug:
                    type: string
                    description: Project URL slug
                  website:
                    type: string
                    nullable: true
                    description: Project website URL
                  createdAt:
                    type: string
                    format: date-time
                    description: Creation timestamp
                  monitors:
                    type: array
                    items:
                      type: object
                      additionalProperties: false
                      required:
                        - id
                        - name
                        - type
                        - models
                        - promptCount
                      properties:
                        id:
                          type: string
                          format: uuid
                          description: Monitor unique identifier
                        name:
                          type: string
                          description: Monitor name
                        type:
                          type: string
                          nullable: true
                          enum:
                            - ORGANIC
                            - BRAND_SPECIFIC
                            - COMPETITOR_COMPARISON
                            - null
                          description: >-
                            Requested prompt type, or null when the monitor used
                            a mixed set
                        models:
                          type: array
                          items:
                            type: string
                          description: LLM models attached to the monitor
                        promptCount:
                          type: integer
                          description: Number of prompts created on the monitor
                    description: Monitors created during setup
                  warning:
                    type: string
                    description: >-
                      Present when the project exists but monitors and prompts
                      were not created
                required:
                  - id
                  - name
                  - slug
                  - createdAt
                  - monitors
                additionalProperties: false
        '400':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: PROJECT_NOT_FOUND
                  message: Project not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - PROJECT_NOT_FOUND
                      - PROJECT_FORBIDDEN
                      - PROJECT_DELETED
                      - PROJECT_LAST_IN_ORG
                      - PROJECT_ORG_FORBIDDEN
                      - PROJECT_ENRICHMENT_FAILED
                      - PROJECT_RETRIEVE_FAILED
                      - PROJECT_FETCH_FAILED
                      - PROJECT_ORG_ACCESS_CHECK_FAILED
                      - PROJECT_RETRIEVE_BY_ORG_FAILED
                      - PROJECT_SLUG_GENERATION_FAILED
                      - PROJECT_SETUP_LIMIT_EXCEEDED
                      - INTERNAL_ERROR
                    example: PROJECT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '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
        '402':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  error: Payment Required
                  message: >-
                    Cannot create prompt. Your organization has 50 of 50 active
                    prompts. Please upgrade your plan to continue.
                  current: 50
                  limit: 50
                  available: 0
                properties:
                  error:
                    type: string
                    description: Fixed error label
                    enum:
                      - Payment Required
                  message:
                    type: string
                    description: Explanation including usage and limit
                  current:
                    type: integer
                    description: Current usage for this quota
                  limit:
                    type: integer
                    description: Maximum allowed on the current plan
                  available:
                    type: integer
                    description: Remaining quota (0 when blocked)
                required:
                  - error
                  - message
                  - current
                  - limit
                  - available
                additionalProperties: false
        '403':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: PROJECT_NOT_FOUND
                  message: Project not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - PROJECT_NOT_FOUND
                      - PROJECT_FORBIDDEN
                      - PROJECT_DELETED
                      - PROJECT_LAST_IN_ORG
                      - PROJECT_ORG_FORBIDDEN
                      - PROJECT_ENRICHMENT_FAILED
                      - PROJECT_RETRIEVE_FAILED
                      - PROJECT_FETCH_FAILED
                      - PROJECT_ORG_ACCESS_CHECK_FAILED
                      - PROJECT_RETRIEVE_BY_ORG_FAILED
                      - PROJECT_SLUG_GENERATION_FAILED
                      - PROJECT_SETUP_LIMIT_EXCEEDED
                      - INTERNAL_ERROR
                    example: PROJECT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
        '500':
          description: Default Response
          content:
            application/json:
              schema:
                type: object
                example:
                  code: PROJECT_NOT_FOUND
                  message: Project not found
                properties:
                  code:
                    type: string
                    description: Error code indicating the type of error
                    enum:
                      - PROJECT_NOT_FOUND
                      - PROJECT_FORBIDDEN
                      - PROJECT_DELETED
                      - PROJECT_LAST_IN_ORG
                      - PROJECT_ORG_FORBIDDEN
                      - PROJECT_ENRICHMENT_FAILED
                      - PROJECT_RETRIEVE_FAILED
                      - PROJECT_FETCH_FAILED
                      - PROJECT_ORG_ACCESS_CHECK_FAILED
                      - PROJECT_RETRIEVE_BY_ORG_FAILED
                      - PROJECT_SLUG_GENERATION_FAILED
                      - PROJECT_SETUP_LIMIT_EXCEEDED
                      - INTERNAL_ERROR
                    example: PROJECT_NOT_FOUND
                  message:
                    type: string
                    description: Human-readable error message
                required:
                  - code
                  - message
                additionalProperties: false
      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.

````