Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
dir
/
{resource}
List directory for resource
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource} \
  --header 'Authorization: Bearer <token>'
{
  "entries": [
    {
      "datatype": "dir",
      "filename": "annotations",
      "is_dir": true,
      "latest_commit": {
        "author": "Ox",
        "email": "ox@oxen.ai",
        "id": "952abd860ffa5635",
        "message": "adding add data",
        "parent_ids": [
          "3c850d9296789f89"
        ],
        "timestamp": "2023-01-06T23:12:59.160132Z"
      },
      "size": 526141
    },
    {
      "datatype": "dir",
      "filename": "images",
      "is_dir": true,
      "latest_commit": {
        "author": "Ox",
        "email": "ox@oxen.ai",
        "id": "952abd860ffa5635",
        "message": "adding add data",
        "parent_ids": [
          "3c850d9296789f89"
        ],
        "timestamp": "2023-01-06T23:12:59.160132Z"
      },
      "size": 99653096
    },
    {
      "datatype": "text",
      "filename": "LICENSE",
      "is_dir": false,
      "latest_commit": {
        "author": "Ox",
        "email": "ox@oxen.ai",
        "id": "952abd860ffa5635",
        "message": "adding add data",
        "parent_ids": [
          "3c850d9296789f89"
        ],
        "timestamp": "2023-01-06T23:12:59.160132Z"
      },
      "size": 20
    },
    {
      "datatype": "markdown",
      "filename": "README.md",
      "is_dir": false,
      "latest_commit": {
        "author": "Ox",
        "email": "ox@oxen.ai",
        "id": "952abd860ffa5635",
        "message": "adding add data",
        "parent_ids": [
          "3c850d9296789f89"
        ],
        "timestamp": "2023-01-06T23:12:59.160132Z"
      },
      "size": 107
    }
  ],
  "page_number": 1,
  "page_size": 10,
  "resource": {
    "path": "./",
    "version": "main"
  },
  "status": "success",
  "status_message": "resource_found",
  "total_entries": 4,
  "total_pages": 0
}
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

(Required)

Example:

"ox"

​
repo_name
string
required
Example:

"test-repo"

​
resource
string
required

(Required) A combination of branch or commit ID plus a path.

Example:

"fake_branch/fake_file.ex"

Response

200 - application/json

OK

​
entries
object[]
Example:
[
  {
    "datatype": "dir",
    "filename": "annotations",
    "is_dir": true,
    "latest_commit": {
      "author": "Ox",
      "email": "ox@oxen.ai",
      "id": "952abd860ffa5635",
      "message": "adding add data",
      "parent_ids": ["3c850d9296789f89"],
      "timestamp": "2023-01-06T23:12:59.160132Z"
    },
    "size": 526141
  },
  {
    "datatype": "dir",
    "filename": "images",
    "is_dir": true,
    "latest_commit": {
      "author": "Ox",
      "email": "ox@oxen.ai",
      "id": "952abd860ffa5635",
      "message": "adding add data",
      "parent_ids": ["3c850d9296789f89"],
      "timestamp": "2023-01-06T23:12:59.160132Z"
    },
    "size": 99653096
  },
  {
    "datatype": "text",
    "filename": "LICENSE",
    "is_dir": false,
    "latest_commit": {
      "author": "Ox",
      "email": "ox@oxen.ai",
      "id": "952abd860ffa5635",
      "message": "adding add data",
      "parent_ids": ["3c850d9296789f89"],
      "timestamp": "2023-01-06T23:12:59.160132Z"
    },
    "size": 20
  },
  {
    "datatype": "markdown",
    "filename": "README.md",
    "is_dir": false,
    "latest_commit": {
      "author": "Ox",
      "email": "ox@oxen.ai",
      "id": "952abd860ffa5635",
      "message": "adding add data",
      "parent_ids": ["3c850d9296789f89"],
      "timestamp": "2023-01-06T23:12:59.160132Z"
    },
    "size": 107
  }
]
​
page_number
number
Example:

1

​
page_size
number
Example:

10

​
resource
object
​
status
string
Example:

"success"

​
status_message
string
Example:

"resource_found"

​
total_entries
number
Example:

4

​
total_pages
number
Example:

0