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

# Upload a file

> Uploads a file as multipart/form-data, proxying the bytes through the API. Maximum file size: 100 MB — for anything larger use POST /files/request-upload and PUT the bytes to the presigned URL (up to 512 MB). The returned `id` can be used to embed the file in descriptions using the `flow-file:` scheme: `![alt](flow-file:{id})`.



## OpenAPI

````yaml /openapi/customer-api.json post /project/{projectId}/files/upload
openapi: 3.0.0
info:
  contact: {}
  description: >-
    Flow customer API reference. Start with the [quickstart](/api/quickstart)
    and [authentication guide](/api/authentication).
  title: Customer API
  version: 1.0.0
servers:
  - description: Flow API
    url: https://backend.branch.flowengineering.com
security: []
tags:
  - name: Automations
  - name: Branches
  - name: Comments
  - name: Convert
  - name: Data Model
  - name: Diagrams
  - name: Entities
  - name: Files
  - name: Import
  - name: Notifications
  - name: Projects
  - name: ReqIF
  - name: ReqIF Import
  - name: Shared Access Grants
  - name: User Groups
  - name: Users
paths:
  /project/{projectId}/files/upload:
    post:
      tags:
        - Files
      summary: Upload a file
      description: >-
        Uploads a file as multipart/form-data, proxying the bytes through the
        API. Maximum file size: 100 MB — for anything larger use POST
        /files/request-upload and PUT the bytes to the presigned URL (up to 512
        MB). The returned `id` can be used to embed the file in descriptions
        using the `flow-file:` scheme: `![alt](flow-file:{id})`.
      operationId: FilesController_upload
      parameters:
        - in: path
          name: projectId
          required: true
          schema:
            type: string
        - description: Branch rendered by the shared Reader view.
          in: query
          name: branchId
          required: false
          schema:
            type: string
        - description: Saved view that granted the external Reader access.
          in: query
          name: viewId
          required: false
          schema:
            type: string
        - description: Reachable entity whose rich text or diagram references the file.
          in: query
          name: entityId
          required: false
          schema:
            type: string
        - description: Workspace identifier
          in: header
          name: customer
          required: true
          schema:
            type: string
      requestBody:
        content:
          multipart/form-data:
            schema:
              properties:
                file:
                  description: File to upload
                  format: binary
                  type: string
              required:
                - file
              type: object
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileRecordResponseDto'
          description: ''
      security:
        - api-key: []
        - bearer: []
components:
  schemas:
    FileRecordResponseDto:
      properties:
        created_at:
          format: date-time
          type: string
        created_by:
          type: string
        id:
          type: string
        mime_type:
          type: string
        original_name:
          type: string
        size:
          type: number
      required:
        - id
        - original_name
        - size
        - mime_type
        - created_by
        - created_at
      type: object
  securitySchemes:
    api-key:
      in: header
      name: X-API-Key
      type: apiKey
    bearer:
      bearerFormat: JWT
      scheme: bearer
      type: http

````