curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"entries": [
{
"extension": "<string>",
"filename": "<string>",
"hash": "<string>",
"is_dir": true,
"mime_type": "<string>",
"size": 1,
"children": "<array>",
"is_queryable": true,
"latest_commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"resource": "<string>",
"version": "<string>",
"branch": {
"commit_id": "<string>",
"name": "<string>"
},
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
}
}
}
],
"page_number": 1,
"page_size": 1,
"total_entries": 1,
"total_pages": 1,
"oxen_version": "<string>",
"dir": {
"extension": "<string>",
"filename": "<string>",
"hash": "<string>",
"is_dir": true,
"mime_type": "<string>",
"size": 1,
"children": "<array>",
"is_queryable": true,
"latest_commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"resource": "<string>",
"version": "<string>",
"branch": {
"commit_id": "<string>",
"name": "<string>"
},
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
}
}
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"version": "<string>"
}
}List directory contents
List paginated contents of a directory at a specific revision, with optional workspace support.
curl --request GET \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource} \
--header 'Authorization: Bearer <token>'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/dir/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"status": "<string>",
"status_message": "<string>",
"entries": [
{
"extension": "<string>",
"filename": "<string>",
"hash": "<string>",
"is_dir": true,
"mime_type": "<string>",
"size": 1,
"children": "<array>",
"is_queryable": true,
"latest_commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"resource": "<string>",
"version": "<string>",
"branch": {
"commit_id": "<string>",
"name": "<string>"
},
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
}
}
}
],
"page_number": 1,
"page_size": 1,
"total_entries": 1,
"total_pages": 1,
"oxen_version": "<string>",
"dir": {
"extension": "<string>",
"filename": "<string>",
"hash": "<string>",
"is_dir": true,
"mime_type": "<string>",
"size": 1,
"children": "<array>",
"is_queryable": true,
"latest_commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"resource": "<string>",
"version": "<string>",
"branch": {
"commit_id": "<string>",
"name": "<string>"
},
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"workspace": {
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"id": "<string>",
"name": "<string>"
}
}
},
"metadata": {
"dir": {
"data_types": [
{
"count": 1,
"data_type": "<string>"
}
]
}
},
"resource": {
"path": "<string>",
"version": "<string>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Namespace of the repository
Name of the repository
Path to the directory (including branch/commit ID)
x >= 0x >= 0Depth of nested directory traversal. 0 = current directory only (default), 1 = include immediate children, -1 = unlimited.
Sort entries by "name" (default) or "date" (latest commit timestamp).
Reverse the sort order. Default is false (ascending).
Response
Paginated list of directory entries
deny_unknown_fields is the discriminator for the untagged EMetadataEntry enum:
payloads with a changes field (i.e. WorkspaceMetadataEntry) fail to deserialize here
and fall through to the workspace variant.
- Option 1
- Option 2
Show child attributes
Show child attributes
x >= 0x >= 0x >= 0x >= 0deny_unknown_fields is the discriminator for the untagged EMetadataEntry enum:
payloads with a changes field (i.e. WorkspaceMetadataEntry) fail to deserialize here
and fall through to the workspace variant.
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes