File Systems

Lists the files and folders stored in a file system. An empty path lists the file system root.

get/v2/file-systems/{file_system_key}/files

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/file-systems/{file_system_key}/files
  • Auth
    HTTP bearer

Path parameters

file_system_keystring required

Query parameters

pathstring
depthinteger
max_entriesinteger

Response

Successfully retrieved the directory listing.

pathstring required

Folder that was listed, relative to the file system root

depthinteger required

Number of folder levels that were walked

entry_countinteger required

Number of entries returned

truncatedboolean required

Whether the listing stopped at max_entries

Changes