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

# List files

> List files uploaded to your project with pagination and filters. Use to show a file library or pick a file for use in workflows (e.g. knowledge, attachments).



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/file
openapi: 3.0.0
info:
  title: Flowra API (API Key Endpoints)
  description: >-
    **Flowra** is an AI-powered platform for building agents, workflows, and
    integrations.


    ### Capabilities

    - **Tools & Toolkits** – Define and group tools for agents and workflows.

    - **Workflows** – Orchestrate steps and automate processes.

    - **Triggers** – Schedule or event-based execution.

    - **Auth & Connections** – OAuth, API keys, and connected accounts.

    - **MCP** – Model Context Protocol server integration.

    - **Knowledge / RAG** – Add files and URLs for retrieval-augmented
    generation.


    ### Authentication

    Use the **x-api-key** header with a project API key to access endpoints that
    support API Key auth. Create and manage API keys in the dashboard under your
    project settings.


    Only endpoints that support API Key authentication via the @ApiKeyEnabled()
    decorator.


    Send x-api-key (required). On multi-tenant endpoints, optionally send
    x-username to act as an external user.
  version: '1.0'
  contact:
    name: Flowra
    url: https://flowra.dev
servers:
  - url: https://flowra.dev
    description: Flowra API
security: []
tags:
  - name: Users
    description: User profile
  - name: External Users
    description: End-user identities inside a project (x-username)
  - name: Auth Configs
    description: OAuth and API key configs for toolkits
  - name: Connected Accounts
    description: OAuth connected accounts and link creation
  - name: Toolkits
    description: List and search toolkits
  - name: Tools
    description: List, execute, and manage tools
  - name: Skills
    description: Browse, create, import, and install skills
  - name: Workflow & Agent
    description: Create, run, and inspect workflows and agents
  - name: Triggers
    description: Schedule and event-based trigger instances
  - name: Chat
    description: Threads and streaming agent runs
  - name: File
    description: Upload, list, and download files
  - name: Knowledge
    description: RAG knowledge collections
  - name: Table
    description: Collections and documents
  - name: Sandbox
    description: Ephemeral and durable code sandboxes
  - name: Browser
    description: Live browser sessions and view
  - name: LLM
    description: List AI models and generate completions
  - name: MCP
    description: MCP server management
  - name: usage
    description: Credit balance and usage ledger for the project API key
paths:
  /api/v1/file:
    get:
      tags:
        - File
      summary: List files
      description: >-
        List files uploaded to your project with pagination and filters. Use to
        show a file library or pick a file for use in workflows (e.g. knowledge,
        attachments).
      operationId: FileController_getFiles
      parameters:
        - name: q
          required: false
          in: query
          description: Search keyword for filtering results
          schema:
            example: john doe
            type: string
        - name: page
          required: false
          in: query
          description: Page number (1-based)
          schema:
            minimum: 1
            default: 1
            example: 1
            type: number
        - name: limit
          required: false
          in: query
          description: Number of items per page
          schema:
            minimum: 1
            maximum: 100
            default: 20
            example: 20
            type: number
        - name: offset
          required: false
          in: query
          description: Number of items to skip (for offset-based pagination)
          schema:
            minimum: 0
            example: 0
            type: number
        - name: sortBy
          required: false
          in: query
          description: Field name to sort by
          schema:
            example: createdAt
            type: string
        - name: sortOrder
          required: false
          in: query
          description: Sort order
          schema:
            default: DESC
            example: DESC
            enum:
              - ASC
              - DESC
            type: string
        - name: fields
          required: false
          in: query
          description: Comma-separated list of fields to include in response
          schema:
            example: id,name,email
            type: string
        - name: format
          required: false
          in: query
          description: Filter files by format/extension
          schema:
            example: png
            type: string
      responses:
        '200':
          description: Files retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileResponseDtoPaginatedResponse'
              example:
                success: true
                message: Data retrieved successfully
                data:
                  - id: ''
                    format: png
                    mimeType: image/png
                    size: 150
                    encoding: 7bit
                    alt: ''
                    originalName: ''
                    projectId: ''
                    ownerEUID: ''
                    fileTypeName: chat
                    fileTypeId: 0
                    createdAt: '2024-01-01T00:00:00.000Z'
                    updatedAt: '2024-01-01T00:00:00.000Z'
                total: 100
                totalTools: 5000
                page: 1
                limit: 20
                totalPages: 5
                hasNextPage: true
                hasPreviousPage: false
      security:
        - x-api-key: []
components:
  schemas:
    FileResponseDtoPaginatedResponse:
      type: object
      properties:
        success:
          type: boolean
          description: Success status
          example: true
        message:
          type: string
          description: Response message
          example: Data retrieved successfully
        data:
          description: Array of items
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: File ID (UUID)
              format:
                type: string
                description: File format/extension
                example: png
              mimeType:
                type: string
                description: MIME type
                example: image/png
              size:
                type: number
                description: File size in KB
                example: 150
              encoding:
                type: string
                description: File encoding
                example: 7bit
              alt:
                type: string
                nullable: true
                description: Alternative text/description
              originalName:
                type: string
                nullable: true
                description: Original file name
              projectId:
                type: string
                nullable: true
                description: Project ID
              ownerEUID:
                type: string
                nullable: true
                description: Owner external user id (eUID)
              fileTypeName:
                type: string
                description: File type name
                example: chat
              fileTypeId:
                type: number
                description: File type ID
              createdAt:
                format: date-time
                type: string
                description: Created at timestamp
              updatedAt:
                format: date-time
                type: string
                description: Updated at timestamp
            required:
              - id
              - format
              - mimeType
              - size
              - encoding
              - alt
              - originalName
              - projectId
              - ownerEUID
              - fileTypeName
              - fileTypeId
              - createdAt
              - updatedAt
          example:
            - id: ''
              format: png
              mimeType: image/png
              size: 150
              encoding: 7bit
              alt: ''
              originalName: ''
              projectId: ''
              ownerEUID: ''
              fileTypeName: chat
              fileTypeId: 0
              createdAt: '2024-01-01T00:00:00.000Z'
              updatedAt: '2024-01-01T00:00:00.000Z'
        total:
          type: number
          description: Total number of items across all pages
          example: 100
        totalTools:
          type: number
          description: >-
            Optional secondary total (e.g. nested tools across all matching
            toolkits)
          example: 5000
        page:
          type: number
          description: Current page number (1-based)
          example: 1
        limit:
          type: number
          description: Number of items per page
          example: 20
        totalPages:
          type: number
          description: Total number of pages
          example: 5
        hasNextPage:
          type: boolean
          description: Whether there is a next page
          example: true
        hasPreviousPage:
          type: boolean
          description: Whether there is a previous page
          example: false
      required:
        - success
        - message
        - data
        - total
  securitySchemes:
    x-api-key:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Project API key. Create and manage keys in the dashboard under Project →
        API Keys. Send as header: x-api-key: <your-key>

````

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