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

# Create a project

> Creates a project in the organisation, with its primary entity.



## OpenAPI

````yaml https://api.mentionlab.io/api/docs/v2-json post /api/v2/organisations/{organisationId}/projects
openapi: 3.0.0
info:
  title: MentionLab Public API v2
  description: ''
  version: 0.6.48
  contact: {}
servers:
  - url: https://api.mentionlab.io
security: []
tags: []
paths:
  /api/v2/organisations/{organisationId}/projects:
    post:
      tags:
        - Projects
      summary: Create a project
      description: Creates a project in the organisation, with its primary entity.
      operationId: ProjectsV2Controller_create_v2
      parameters:
        - name: organisationId
          required: true
          in: path
          schema:
            format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateProjectV2Dto'
      responses:
        '201':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProjectV2Response'
        '400':
          description: >-
            The request failed validation: the body, query or path parameters
            are malformed or out of range.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: The request is missing valid authentication credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The authenticated principal lacks the required permission, or access
            to the requested organisation/project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  schemas:
    CreateProjectV2Dto:
      type: object
      properties:
        name:
          type: string
          description: Display name; needs two letters or digits
          example: Acme
          maxLength: 100
        website:
          type: string
          description: The website of the entity the project tracks, stored as entered
          example: https://www.mentionlab.io
        industry:
          type: string
          description: Sector the project competes in
          example: Cosmetics
        description:
          type: string
          description: Free text about what the project covers
          example: Skincare and haircare lines sold in Europe
        entityType:
          type: string
          enum:
            - brands
            - brands_and_products
            - countries_cities
            - organisations
            - people
            - places
            - facilities
            - events
          description: >-
            What the project tracks, brands when absent. A change applies to new
            answers only
          example: countries_cities
        analysisInstructions:
          type: string
          nullable: true
          maxLength: 500
          description: >-
            Extra instructions for the analysis of the project's answers, for
            new answers only; an empty string clears them
          example: Do not count retailers or marketplaces as brands.
        themeAnalysisEnabled:
          type: boolean
          description: >-
            Turns on the theme analysis of the project's answers; the
            organisation's plan must include it
          example: true
        themeLanguage:
          type: string
          enum:
            - auto
            - en
            - fr
            - nl
            - de
            - es
            - it
            - pt
          description: The themes' language; auto lets each theme follow its answer
          example: auto
      required:
        - name
    ProjectV2Response:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Uuid of the project, the id every project-scoped route takes
        name:
          type: string
          description: Display name; the slug does not follow a later rename
        slug:
          type: string
          description: URL segment
        website:
          type: string
          description: As entered, e.g. https://www.mentionlab.io
        industry:
          type: string
          description: Sector the project competes in
        description:
          type: string
          description: Free text about what the project covers
        entityType:
          type: string
          enum:
            - brands
            - brands_and_products
            - countries_cities
            - organisations
            - people
            - places
            - facilities
            - events
          description: What the project tracks; the entity-types list gives its labels
        analysisInstructions:
          type: string
          nullable: true
          description: Extra instructions added to the analysis of the project's answers
        themeAnalysisEnabled:
          type: boolean
          description: Whether the project's answers get a theme analysis
          example: false
        themeLanguage:
          type: string
          enum:
            - auto
            - en
            - fr
            - nl
            - de
            - es
            - it
            - pt
          description: The themes' language; auto lets each theme follow its answer
          example: en
        queryCount:
          type: number
          description: Queries the project tracks
        role:
          type: string
          enum:
            - project_manager
            - project_editor
            - project_viewer
          description: >-
            The caller's role in the project; absent unless it is a member, so
            always absent for an API key
        permissions:
          type: array
          description: What the caller may do in the project
          items:
            type: string
            enum:
              - project:read
              - project:write
              - project:delete
              - project:manage_members
              - stats:read
        customFilters:
          description: The filters pinned for the project, in order
          type: array
          items:
            $ref: '#/components/schemas/ProjectCustomFilterV2Dto'
      required:
        - id
        - name
        - slug
        - entityType
        - analysisInstructions
        - themeAnalysisEnabled
        - themeLanguage
        - queryCount
        - permissions
        - customFilters
    ApiErrorResponse:
      type: object
      properties:
        statusCode:
          type: number
          description: HTTP status code of the error.
          example: 400
        message:
          type: string
          description: >-
            Human-readable description of the error. Validation failures return
            an array of per-field validation errors instead of a single string.
          example: Validation failed
        error:
          type: string
          description: Short name of the HTTP error.
          example: Bad Request
      required:
        - statusCode
    ProjectCustomFilterV2Dto:
      type: object
      properties:
        type:
          type: string
          example: tag-group
          description: Filter kind, e.g. 'tag-group' or 'continent'.
        id:
          type: string
          example: 01234567-89ab-cdef-0123-456789abcdef
          description: 'Target id: a tag-group uuid, or the continent label.'
      required:
        - type
        - id

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.