Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
dir
/
{resource}
List directory contents
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "status_message": "<string>",
  "entries": [
    {
      "data_type": "dir",
      "extension": "<string>",
      "filename": "<string>",
      "hash": "<string>",
      "is_dir": true,
      "mime_type": "<string>",
      "size": 1,
      "is_queryable": true,
      "latest_commit": "<unknown>",
      "metadata": "<unknown>",
      "resource": "<unknown>"
    }
  ],
  "page_number": 1,
  "page_size": 1,
  "total_entries": 1,
  "total_pages": 1,
  "oxen_version": "<string>",
  "dir": "<unknown>",
  "metadata": "<unknown>",
  "resource": "<unknown>"
}
List files and directories in a repository at a given revision and path. The resource is the combination of the revision and the path to the directory to list. For example, main/images would list the files and directories in the images directory at the main branch.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
namespace
string
required

Namespace of the repository

​
repo_name
string
required

Name of the repository

​
resource
string
required

Path to the directory (including branch/commit ID)

​
page
integer | null
required
Required range: x >= 0
​
page_size
integer | null
required
Required range: x >= 0
​
api_version
string | null
required

Response

Paginated list of directory entries

​
status
string
required
​
status_message
string
required
​
entries
object[]
required
​
page_number
integer
required
Required range: x >= 0
​
page_size
integer
required
Required range: x >= 0
​
total_entries
integer
required
Required range: x >= 0
​
total_pages
integer
required
Required range: x >= 0
​
oxen_version
string | null
​
dir
object
​
metadata
object
​
resource
object