> ## Documentation Index > Fetch the complete documentation index at: https://docs.surfacd.com/llms.txt > Use this file to discover all available pages before exploring further. # Create Project > Creates a project for the current team, with its primary brand and the set of services (AI platforms) to monitor. The brand domain is normalised (protocol, `www`, and path are stripped). ## OpenAPI ````yaml /openapi.json post /api/v1/projects openapi: 3.1.0 info: title: Surfacd Public API version: 1.0.0 description: >- Public API for Surfacd. Team-scoped operations live under `/api/v1/team/...`; project collections live under `/api/v1/projects`; project-scoped operations live under `/api/v1/projects/{project}/...`. All endpoints require a Bearer team API key created in Team Settings. The API key selects the team for team-level and collection endpoints. servers: - url: https://app.surfacd.com description: Production security: - bearerAuth: [] tags: - name: Projects description: Project management endpoints. Reads only in this version. - name: Prompts description: Prompt management endpoints. Reads only in this version. - name: Team description: Team settings and plan details for the current team. - name: Reporting description: >- Read-only reporting endpoints for projects (brand rankings, mentions, visibility, matrix analysis, source data). - name: Reference description: Reference data used by create, update, and reporting filters. - name: Tags description: Project tag management endpoints. paths: /api/v1/projects: post: tags: - Projects summary: Create Project description: >- Creates a project for the current team, with its primary brand and the set of services (AI platforms) to monitor. The brand domain is normalised (protocol, `www`, and path are stripped). operationId: v1ProjectsStore requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectRequest' responses: '201': description: The created project. content: application/json: schema: $ref: '#/components/schemas/Project' '422': $ref: '#/components/responses/ValidationError' components: schemas: CreateProjectRequest: type: object properties: name: type: string maxLength: 255 check_frequency: $ref: '#/components/schemas/CheckFrequency' default_country_code: type: string description: ISO 3166-1 alpha-2 code of an active country. prompt_limit: type: - integer - 'null' minimum: 1 maximum: 1000 description: >- Optional per-project prompt limit. Falls back to the team default when omitted. services: type: array minItems: 1 items: type: string description: >- Active services (AI platforms) to monitor. Each entry may be either a service UUID or provider slug such as `chatgpt` or `perplexity`. Discover both values with `GET /api/v1/platforms`. primary_brand: $ref: '#/components/schemas/CreateProjectBrandInput' required: - name - check_frequency - default_country_code - services - primary_brand Project: type: object properties: uuid: type: string format: uuid name: type: string check_frequency: $ref: '#/components/schemas/CheckFrequency' project_type: $ref: '#/components/schemas/ProjectType' pitch_ends_at: type: - string - 'null' format: date-time description: >- End of the 7-day pitch collection window. Only set for pitch projects once their first collection run starts; always null for standard projects. Read-only. prompt_limit: type: integer description: >- Resolved prompt limit. Falls back to the team default when not explicitly set on the project. archived_at: type: - string - 'null' format: date-time created_at: type: string format: date-time updated_at: type: string format: date-time default_country: oneOf: - $ref: '#/components/schemas/ProjectCountry' - type: 'null' primary_brand: oneOf: - $ref: '#/components/schemas/ProjectBrand' - type: 'null' services: type: array items: $ref: '#/components/schemas/ProjectService' description: Active services (AI platforms) enabled for this project. share: $ref: '#/components/schemas/ProjectShare' required: - uuid - name - check_frequency - project_type - pitch_ends_at - prompt_limit - archived_at - created_at - updated_at - default_country - primary_brand - services - share CheckFrequency: type: string enum: - manual - monthly - weekly - daily CreateProjectBrandInput: type: object properties: name: type: string maxLength: 255 domain: type: string maxLength: 255 description: Brand domain. Protocol, www, and path are stripped on save. aliases: type: array items: type: string maxLength: 255 description: Alternative names the brand is known by. required: - name - domain ProjectType: type: string enum: - standard - pitch description: >- Project type. `pitch` projects run a fixed 7-day collection window and do not consume credits. ProjectCountry: type: object properties: code: type: string description: ISO 3166-1 alpha-2 country code (lowercase). name: type: string required: - code - name ProjectBrand: type: object properties: uuid: type: string format: uuid name: type: string domain: type: - string - 'null' type: $ref: '#/components/schemas/BrandType' brand_aliases: type: array items: type: string required: - uuid - name - domain - type - brand_aliases ProjectService: type: object properties: uuid: type: string format: uuid description: Public platform UUID. May be sent in project `services` arrays. name: type: string description: Machine name (e.g. `chatgpt`). display_name: type: string provider: type: string description: >- Public provider slug. Use this in reporting `services` filters; it may also be sent in project `services` arrays. required: - uuid - name - display_name - provider ProjectShare: type: object properties: enabled: type: boolean share_url: type: - string - 'null' description: >- The public share URL (includes the token). Null when sharing is disabled. password_protected: type: boolean description: Whether a password is required to view the shared project. required: - enabled - share_url - password_protected ValidationError: type: object description: Returned when one or more request parameters fail validation. properties: message: type: string errors: type: object additionalProperties: type: array items: type: string required: - message - errors BrandType: type: integer enum: - 0 - 1 - 2 description: >- `0` = Standard, `1` = Primary (the project's own brand), `2` = Competitor. responses: ValidationError: description: Validation failed. content: application/json: schema: $ref: '#/components/schemas/ValidationError' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: token description: >- Team API key created in Team Settings. Use it with URLs for the same team. ````