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

# Create a new project



## OpenAPI

````yaml /api-reference/openapi.json post /projects
openapi: 3.1.0
info:
  title: OpenLens API
  version: 1.4.0
  description: >-
    Public REST API for OpenLens. Onboard clients, run scans across the major AI
    platforms, read visibility metrics, and download client-ready reports. Beta
    — endpoints may evolve before GA.
  contact:
    name: OpenLens support
    email: contact@aibread.com
servers:
  - url: https://openlens.com/api
security:
  - bearerAuth: []
tags:
  - name: Onboarding
  - name: Runs
  - name: Metrics
  - name: Citations
  - name: Deliverables
  - name: Resources
  - name: Account
  - name: Workstreams
paths:
  /projects:
    post:
      tags:
        - Resources
      summary: Create a new project
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                url:
                  type:
                    - string
                    - 'null'
              required:
                - name
      responses:
        '201':
          description: Project created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Project'
        '400':
          description: Missing or invalid request parameter.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '402':
          description: >-
            Monthly included API calls for your tier are used up (code
            `USAGE_LIMIT`). Body includes a `limit` object — `{ limitHit,
            currentTier, targetTier, feature, cap, used, resetAt }` — describing
            the cap and the upgrade that lifts it.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Resource not found or not owned by your account.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Rate limit, project cap, or daily quota hit. Body includes a `code`
            field.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Server error. Retry; if persistent, contact support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Project:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        url:
          type:
            - string
            - 'null'
        location:
          type:
            - string
            - 'null'
        languages:
          type:
            - string
            - 'null'
        activePlatforms:
          type: array
          items:
            type: string
            enum:
              - chatgpt
              - chatgpt_app
              - claude
              - gemini
              - gemini_app
              - grok_app
              - grok_api
              - perplexity
              - perplexity_app
              - google_app
              - deepseek
            description: >-
              LLM platform identifier. Newer scraper-backed ids end in `_app`;
              `chatgpt`, `perplexity`, and `gemini` are legacy and not returned
              by current runs.
        createdAt:
          type: string
          format: date-time
        ownBrandName:
          type:
            - string
            - 'null'
        ownBrandUrl:
          type:
            - string
            - 'null'
        lastRunAt:
          type:
            - string
            - 'null'
          format: date-time
        lastRunStatus:
          type:
            - string
            - 'null'
      required:
        - id
        - name
    Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: string
          description: Stable machine code for programmatic handling, when applicable.
      required:
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: Clerk API key. Create one from your account settings under API Keys.

````