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

# Create Folder

> Creates a folder under an owner — a configured entity (`entityType` +
`entityId`) or the company level (`entityType: "company"`, no
`entityId`). Optionally nest it under one of the owner's existing
folders with `parentFolderId`; omit it for a top-level folder. A folder
can only ever contain files and subfolders of its own owner.

**Required permission:** `company.file:create`




## OpenAPI

````yaml /openapi/generated-external-api.yaml post /api/v1/companies/{companyId}/folders
openapi: 3.0.3
info:
  title: AI Insurance External API
  description: External API for AI Insurance platform
  version: 1.0.0
  contact:
    email: support@aiinsurance.io
servers:
  - url: https://go.aiinsurance.io
    description: Production
security:
  - ApiKeyAuth: []
paths:
  /api/v1/companies/{companyId}/folders:
    post:
      tags:
        - Company Files
      summary: Create Folder
      description: |
        Creates a folder under an owner — a configured entity (`entityType` +
        `entityId`) or the company level (`entityType: "company"`, no
        `entityId`). Optionally nest it under one of the owner's existing
        folders with `parentFolderId`; omit it for a top-level folder. A folder
        can only ever contain files and subfolders of its own owner.

        **Required permission:** `company.file:create`
      operationId: createFolder
      parameters:
        - $ref: '#/components/parameters/companyId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - entityType
                - name
              properties:
                entityType:
                  type: string
                  enum:
                    - event
                    - exposure
                    - quote
                    - submission
                    - person
                    - organization
                    - policy
                    - company
                  description: The folder owner's entity type
                entityId:
                  type: string
                  format: uuid
                  nullable: true
                  description: >
                    The owner entity's id. Required for every `entityType`

                    except `company` (omit or send null for company-level
                    folders).
                parentFolderId:
                  type: string
                  format: uuid
                  nullable: true
                  description: Parent folder to nest under (omit or null for top-level)
                name:
                  type: string
                  description: Folder name (must be non-empty)
            examples:
              companyTopLevelFolder:
                summary: Company-level top-level folder
                value:
                  entityType: company
                  name: Claims Documents
              nestedEntityFolder:
                summary: Exposure-owned subfolder
                value:
                  entityType: exposure
                  entityId: 550e8400-e29b-41d4-a716-446655440010
                  parentFolderId: 550e8400-e29b-41d4-a716-446655440001
                  name: 2026 Q1
      responses:
        '201':
          description: Folder created successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    format: uuid
                    description: Id of the created folder
              examples:
                success:
                  summary: Folder created
                  value:
                    id: 550e8400-e29b-41d4-a716-446655440001
        '400':
          description: Bad Request — Validation error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                emptyName:
                  summary: Empty folder name (rejected by the request validator)
                  value:
                    error:
                      code: InvalidProperties
                      message: 'name: The value is an empty string'
                      userMessages:
                        - The value is an empty string
                      details:
                        - field: name
                          message: The value is an empty string
                whitespaceName:
                  summary: >-
                    Whitespace-only folder name (rejected by the operations
                    layer)
                  value:
                    error:
                      code: BadRequest
                      message: Folder name must not be empty
                      userMessages:
                        - Folder name must not be empty
                wrongOwnerParent:
                  summary: Parent folder belongs to a different owner
                  value:
                    error:
                      code: BadRequest
                      message: Folder does not belong to the file owner
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          description: Owner entity or parent folder not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                parentNotFound:
                  summary: Parent folder does not exist
                  value:
                    error:
                      code: NotFound
                      message: 'Folder not found: 550e8400-e29b-41d4-a716-446655440001'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    companyId:
      name: companyId
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: Company identifier
  schemas:
    ErrorResponse:
      type: object
      description: Standard error response for all external API endpoints
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              type: string
              description: Machine-readable error code
              example: VALIDATION_ERROR
            message:
              type: string
              description: Human-readable error message
              example: 'submissionId: Required field is missing'
            userMessages:
              type: array
              description: >-
                Clean, verbatim-displayable messages — one entry per failure,
                free of error-code tags, field paths, and internal noise.
                Suitable for showing to end users as-is.
              items:
                type: string
              example:
                - Exposures of type 'company' require an address
            details:
              type: array
              description: Additional details for validation errors (field-level errors)
              items:
                type: object
                properties:
                  field:
                    type: string
                    description: The field that caused the error
                    example: submissionId
                  message:
                    type: string
                    description: Description of the field error
                    example: Required field is missing
  responses:
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            missingApiKey:
              summary: Missing API key
              value:
                error:
                  code: AuthenticationError
                  message: API key authentication required
                  userMessages:
                    - API key authentication required
            invalidApiKey:
              summary: >-
                Invalid API key (e.g. unknown key, or a Bearer token used
                instead of an API key)
              value:
                error:
                  code: AuthenticationError
                  message: Invalid API key
                  userMessages:
                    - Invalid API key
    Forbidden:
      description: Forbidden - Insufficient permissions
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            insufficientPermissions:
              summary: Insufficient permissions
              value:
                error:
                  code: AuthorizationError
                  message: User is not authorized to perform the requested action
                  userMessages:
                    - User is not authorized to perform the requested action
            companyMismatch:
              summary: A valid API key naming another company in the URL
              value:
                error:
                  code: AuthorizationError
                  message: API key is not scoped to the requested company
                  userMessages:
                    - API key is not scoped to the requested company
    InternalServerError:
      description: Internal Server Error - Unexpected error occurred
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
          examples:
            internalError:
              summary: Unexpected server error
              value:
                error:
                  code: UncaughtActionError
                  message: Uncaught error occurred in <actionName>
                  userMessages:
                    - An unexpected error occurred. Please try again later.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        API key authentication. Send your raw API key as the `Authorization`
        header value with NO scheme prefix — `Authorization: YOUR-API-KEY`. Do
        NOT prefix it with `Bearer ` or `ApiKey `, and do not use an `X-API-Key`
        header; those are not accepted.

````