{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/llmpulse-ai/json-schema/llmpulse-ai-project-create-request-schema.json",
  "title": "ProjectCreateRequest",
  "x-generated": "2026-11-17",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/llmpulse-ai-openapi.json#/components/schemas/ProjectCreateRequest",
  "type": "object",
  "required": [
    "website_url",
    "name",
    "main_country",
    "main_language"
  ],
  "properties": {
    "website_url": {
      "type": "string",
      "format": "uri",
      "description": "Public HTTP(S) URL with a DNS hostname or public IP address. Credentials, private and special IP addresses, localhost and internal hostnames are rejected."
    },
    "name": {
      "type": "string",
      "description": "Project name, as plain text. It can be changed later with PATCH /projects/{id}"
    },
    "main_country": {
      "type": "string"
    },
    "main_language": {
      "type": "string"
    },
    "brand_name": {
      "type": "string",
      "maxLength": 100,
      "description": "Defaults to name. Up to 100 characters, the name included when it stands in; a longer one is refused with ERR_INVALID_PARAM"
    },
    "description": {
      "type": "string"
    },
    "industry": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Industry keys, case-insensitive; a single key string is also accepted. An unknown key returns ERR_INVALID_PARAM listing the valid keys (the same list as the in-app industry picker, e.g. TECHNOLOGY, SAAS, ECOMMERCE)"
    },
    "business_model": {
      "type": "string",
      "description": "Business model key (e.g. B2B_SAAS, MARKETPLACE); unknown keys are rejected"
    },
    "business_model_other": {
      "type": "string",
      "description": "Free-text business model, only accepted when business_model is OTHER; rejected against any other key"
    },
    "target_audience": {
      "type": "string",
      "description": "Who the brand sells to. Context for Recommendations and GEO Writer (Brand Book)"
    },
    "brand_voice": {
      "type": "string",
      "description": "Tone of voice guidance for generated content (Brand Book)"
    },
    "goals": {
      "type": "string",
      "description": "What the brand wants to achieve. Context for GEO Writer and prompt suggestions"
    },
    "primary_products": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Main products or services"
    },
    "matching_names": {
      "type": "array",
      "maxItems": 50,
      "items": {
        "type": "string",
        "maxLength": 100
      },
      "description": "Brand-name variants used to detect mentions. At most 50 names of up to 100 characters each; a longer list or name is refused with ERR_INVALID_PARAM (422) and nothing is created"
    },
    "prompts": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "maxItems": 100
    },
    "collections": {
      "type": "array",
      "maxItems": 50,
      "description": "Collections (prompt tags) created with the project, each tagging prompts of this request by their exact text, so no separate tagging calls are needed. A text that is not in prompts returns ERR_INVALID_PARAM. A team member also needs Tags: Create permission.",
      "items": {
        "type": "object",
        "required": [
          "name"
        ],
        "properties": {
          "name": {
            "type": "string",
            "maxLength": 100
          },
          "prompts": {
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    },
    "competitors": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "domain"
        ],
        "properties": {
          "domain": {
            "type": "string"
          },
          "brand_name": {
            "type": "string"
          },
          "matching_names": {
            "type": "array",
            "maxItems": 50,
            "items": {
              "type": "string",
              "maxLength": 100
            },
            "description": "Names this competitor is matched by. At most 50 names of up to 100 characters each; a longer list or name is refused with ERR_INVALID_PARAM (422) and nothing is created"
          }
        }
      }
    },
    "owned_media": {
      "type": "object",
      "description": "Requires Growth plan or above",
      "properties": {
        "youtube_channel_url": {
          "type": "string"
        },
        "instagram_profile_url": {
          "type": "string"
        },
        "facebook_page_url": {
          "type": "string"
        },
        "tiktok_profile_url": {
          "type": "string"
        },
        "app_store_url": {
          "type": "string"
        },
        "google_play_url": {
          "type": "string"
        }
      }
    },
    "use_subdomain": {
      "type": "boolean",
      "default": false
    },
    "weekly_email_subscribed": {
      "type": "boolean",
      "default": false
    },
    "external_identifier": {
      "type": "string",
      "pattern": "^[a-z0-9_-]{1,64}$",
      "description": "Embed-enabled (Enterprise) accounts only; other accounts receive ERR_PLAN_REQUIRED. Idempotency key and embed-session join key, unique per account"
    },
    "execute_prompts_immediately": {
      "type": "boolean",
      "default": true
    },
    "pitch": {
      "type": "boolean",
      "default": false,
      "description": "Create a pitch project, a one-off snapshot for a prospect. It runs its prompts once across the account's AI models right away, takes no project slot and its prompts do not count against the prompt quota, and it is deleted 90 days later unless converted by sending pitch false to PATCH /projects/{id}. It uses one of the month's pitch projects (GET /account, limits.pitch_projects), needs an agency or platform account (GET /account, limits.pitch_projects.access) and a paid subscription on the Scale tier or higher, takes 1 to 100 prompts, and cannot use a domain the account already tracks or pitched in the last 90 days. execute_prompts_immediately must not be false"
    },
    "project_type": {
      "type": "string",
      "description": "Only for accounts billed per project type under a pricing agreement; any other account gets ERR_INVALID_PARAM. The key of one of the account's project types, such as core or lean, which sets the most prompts the project can hold and the price it is billed at. Omitted, the project takes the account's default type. A type other than the default needs the account owner or a co-owner (ERR_INSUFFICIENT_PERMISSION). An unknown key answers ERR_INVALID_PARAM with the valid keys; a pitch project has no type"
    }
  }
}