> ## Documentation Index
> Fetch the complete documentation index at: https://allhandsai-chore-regenerate-agent-sdk-openapi.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Home Directory

> Return the agent-server user's home directory and dynamic sidebar lists.

``favorites`` is the set of top-level directories actually present in the
user's home (so it reflects the real environment instead of a hardcoded
list of names that may not exist). Hidden directories are included only
when ``include_hidden`` is True. ``locations`` is the set of filesystem
roots — '/' on POSIX or available drive letters on Windows.



## OpenAPI

````yaml /openapi/agent-sdk.json get /api/file/home
openapi: 3.1.0
info:
  description: OpenHands Agent Server - REST/WebSocket interface for OpenHands AI Agent
  title: OpenHands Agent Server
  version: 1.52.0
servers: []
security: []
paths:
  /api/file/home:
    get:
      tags:
        - Files
      summary: Get Home Directory
      description: >-
        Return the agent-server user's home directory and dynamic sidebar lists.


        ``favorites`` is the set of top-level directories actually present in
        the

        user's home (so it reflects the real environment instead of a hardcoded

        list of names that may not exist). Hidden directories are included only

        when ``include_hidden`` is True. ``locations`` is the set of filesystem

        roots — '/' on POSIX or available drive letters on Windows.
      operationId: get_home_directory_api_file_home_get
      parameters:
        - description: Include hidden top-level directories in `favorites`
          in: query
          name: include_hidden
          required: false
          schema:
            default: false
            description: Include hidden top-level directories in `favorites`
            title: Include Hidden
            type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HomeResponse'
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - APIKeyHeader: []
components:
  schemas:
    HomeResponse:
      properties:
        favorites:
          default: []
          items:
            $ref: '#/components/schemas/FileBrowserEntry'
          title: Favorites
          type: array
        home:
          title: Home
          type: string
        locations:
          default: []
          items:
            $ref: '#/components/schemas/FileBrowserEntry'
          title: Locations
          type: array
      required:
        - home
      title: HomeResponse
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    FileBrowserEntry:
      properties:
        label:
          title: Label
          type: string
        path:
          title: Path
          type: string
      required:
        - label
        - path
      title: FileBrowserEntry
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    APIKeyHeader:
      in: header
      name: X-Session-API-Key
      type: apiKey

````

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