---
title: "GET /api/files/navigation"
method: GET
path: "/api/files/navigation"
tags: ["Ai.Tlbx.MidTerm.OpenApi"]
---

# GET /api/files/navigation

`GET /api/files/navigation`

## Request

- The document declares no server URL.
- Auth: none declared

## Query parameters

- `path` string, required
- `sessionId` string
- `includeDetectedRoots` boolean

## Response `200`

OK

- FileNavigationResponse
  - `path` string, required
  - `parentPath` string, nullable, required
  - `exists` boolean, required
  - `isDirectory` boolean, required
  - `workingDirectory` string, nullable, required
  - `breadcrumbs` FileNavigationLocation[], required
    - `path` string, required
    - `name` string, required
  - `roots` FileNavigationRoot[], required
    - `path` string, required
    - `name` string, required
    - `kind` string, required
  - `file` FileTreeEntry, required
    - `name` string, required
    - `fullPath` string, required
    - `isDirectory` boolean, required
    - `size` integer, nullable, required
    - `mimeType` string, nullable, required
    - `isText` boolean, nullable, required
    - `gitStatus` string, nullable, required
    - `modified` string, date-time, nullable, required
    - `isHidden` boolean, required
    - `isIgnored` boolean, required

## Other responses

- `403`: Forbidden

## Changes

- **2026-10-16** `ede29bacc7aa`: 1 info
  - added the new optional `query` request parameter `includeDetectedRoots`
- **2026-10-11** `bfd3f16d9d41`: 3 info
  - added the required property `file/oneOf[#/components/schemas/FileTreeEntry]/isHidden` to the response with the `200` status
  - added the required property `file/oneOf[#/components/schemas/FileTreeEntry]/isIgnored` to the response with the `200` status
  - added the required property `file/oneOf[#/components/schemas/FileTreeEntry]/modified` to the response with the `200` status
- **2026-10-11** `9ac68f3125a9`: 4 info
  - added the required property `breadcrumbs` to the response with the `200` status
  - added the required property `file` to the response with the `200` status
  - added the required property `roots` to the response with the `200` status
  - added the required property `workingDirectory` to the response with the `200` status
- **2026-10-11** `16b3befef5ea`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/tlbx-ai/apis/tlbx-api/changes/api/files/navigation/get.md)

---

[API](https://skmtc.dev/tlbx-ai/apis/tlbx-api.md) - [All operations](https://skmtc.dev/tlbx-ai/apis/tlbx-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tlbx-ai/apis/tlbx-api/revisions/3af271140994?raw)