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

# Summarize Filesystem

> Summarize a directory tree on a connector filesystem root without listing it: file/dir counts, total bytes, largest files, extension histogram. The probe to run before a recursive copy. Requires fs:browse (0.1.27+).



## OpenAPI

````yaml GET /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/summary
openapi: 3.1.0
info:
  title: Timbal Platform API
  description: Public API documentation for the Timbal platform
  license:
    name: ''
  version: 2.0.0
servers:
  - url: https://api.timbal.ai
    description: Production
  - url: https://api.dev.timbal.ai
    description: Development
security: []
tags:
  - name: ace
    description: Action Control Engine (ACE) operations
  - name: analytics
    description: Org and project analytics
  - name: billing
    description: Subscriptions, usage, and payment-related operations
  - name: content
    description: Re-sign stored content URLs
  - name: files
    description: File operations
  - name: iam
    description: IAM — actions, roles, users, and authorization introspection
  - name: k2
    description: Knowledge Bases v2 operations
  - name: orgs
    description: Organization operations
  - name: projects
    description: Project operations
  - name: runs
    description: Execution operations
  - name: templates
    description: Public project template catalog
  - name: users
    description: Authenticated user profile
paths:
  /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/summary:
    get:
      tags:
        - connectors
      summary: >-
        `GET
        /orgs/{org_id}/connectors/{connector_id}/browse/filesystems/summary`
      description: >-
        Summarize a directory tree on a connector filesystem root without
        listing it: file/dir counts, total bytes, largest files, extension
        histogram. The probe to run before a recursive copy. Requires fs:browse
        (0.1.27+).
      operationId: summary
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: connector_id
          in: path
          required: true
          schema:
            type: string
        - name: filesystem_ref
          in: query
          description: Filesystem root ref on the node (from `/browse/filesystems`).
          required: true
          schema:
            type: string
        - name: path
          in: query
          description: Directory relative to the root; omit for the root itself.
          required: false
          schema:
            type: string
        - name: timeout_ms
          in: query
          description: >-
            Node-side walk budget in milliseconds (default 20000, ceiling
            30000).

            `0` / omit = node default.
          required: false
          schema:
            type: integer
            format: int64
            minimum: 0
      responses:
        '200':
          description: Tree summarized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FsDuRes'
        '403':
          description: Forbidden
        '404':
          description: Connector not found
        '422':
          description: Connector offline / refused / timed out / too old
      security:
        - bearer_auth: []
components:
  schemas:
    FsDuRes:
      type: object
      required:
        - file_count
        - dir_count
        - total_bytes
        - truncated
        - largest
        - by_extension
        - max_depth
      properties:
        by_extension:
          type: array
          items:
            $ref: '#/components/schemas/FsExtStatView'
          description: Per-extension rollup, by bytes descending.
        dir_count:
          type: integer
          format: int64
          minimum: 0
        file_count:
          type: integer
          format: int64
          minimum: 0
        largest:
          type: array
          items:
            $ref: '#/components/schemas/FsLargestFileView'
          description: Top-N files by size, descending.
        max_depth:
          type: integer
          format: int32
          description: Deepest directory level seen (the walk root = 0).
          minimum: 0
        total_bytes:
          type: integer
          format: int64
          description: Sum of regular-file sizes seen (symlinks excluded).
          minimum: 0
        truncated:
          type: boolean
          description: The walk hit a cap — every count is a floor, not a total.
        truncated_reason:
          type:
            - string
            - 'null'
    FsExtStatView:
      type: object
      required:
        - extension
        - count
        - bytes
      properties:
        bytes:
          type: integer
          format: int64
          minimum: 0
        count:
          type: integer
          format: int64
          minimum: 0
        extension:
          type: string
          description: Lowercased, no dot; extensionless files roll up under `""`.
    FsLargestFileView:
      type: object
      required:
        - path
        - size_bytes
      properties:
        path:
          type: string
          description: Root-relative path.
        size_bytes:
          type: integer
          format: int64
          minimum: 0
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      description: >-
        Timbal API key. Obtain your API key from the Timbal platform settings.
        See [Authentication](/api-reference/authentication) for more
        information.

````