Create data frame from directory
curl --request POST \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_message": "Generated image index",
"extra_columns": [
"size",
"extension"
],
"output_path": "data/image_index.csv",
"recursive": true,
"user_email": "bessie@oxen.ai",
"user_name": "Bessie"
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}"
payload = {
"commit_message": "Generated image index",
"extra_columns": ["size", "extension"],
"output_path": "data/image_index.csv",
"recursive": True,
"user_email": "bessie@oxen.ai",
"user_name": "Bessie"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
commit_message: 'Generated image index',
extra_columns: ['size', 'extension'],
output_path: 'data/image_index.csv',
recursive: true,
user_email: 'bessie@oxen.ai',
user_name: 'Bessie'
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{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}/data_frames/from_directory/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'commit_message' => 'Generated image index',
'extra_columns' => [
'size',
'extension'
],
'output_path' => 'data/image_index.csv',
'recursive' => true,
'user_email' => 'bessie@oxen.ai',
'user_name' => 'Bessie'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}"
payload := strings.NewReader("{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}"
response = http.request(request)
puts response.read_body{
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"status": "success",
"status_message": "resource_found"
}Data Frames
Create data frame from directory
Create a data frame by scanning directory contents and commit it to a branch.
POST
/
api
/
repos
/
{namespace}
/
{repo_name}
/
data_frames
/
from_directory
/
{resource}
Create data frame from directory
curl --request POST \
--url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"commit_message": "Generated image index",
"extra_columns": [
"size",
"extension"
],
"output_path": "data/image_index.csv",
"recursive": true,
"user_email": "bessie@oxen.ai",
"user_name": "Bessie"
}
'import requests
url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}"
payload = {
"commit_message": "Generated image index",
"extra_columns": ["size", "extension"],
"output_path": "data/image_index.csv",
"recursive": True,
"user_email": "bessie@oxen.ai",
"user_name": "Bessie"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
commit_message: 'Generated image index',
extra_columns: ['size', 'extension'],
output_path: 'data/image_index.csv',
recursive: true,
user_email: 'bessie@oxen.ai',
user_name: 'Bessie'
})
};
fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{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}/data_frames/from_directory/{resource}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'commit_message' => 'Generated image index',
'extra_columns' => [
'size',
'extension'
],
'output_path' => 'data/image_index.csv',
'recursive' => true,
'user_email' => 'bessie@oxen.ai',
'user_name' => 'Bessie'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}"
payload := strings.NewReader("{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/from_directory/{resource}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commit_message\": \"Generated image index\",\n \"extra_columns\": [\n \"size\",\n \"extension\"\n ],\n \"output_path\": \"data/image_index.csv\",\n \"recursive\": true,\n \"user_email\": \"bessie@oxen.ai\",\n \"user_name\": \"Bessie\"\n}"
response = http.request(request)
puts response.read_body{
"commit": {
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": [
"f1e2d3c4b5a67890fedcba9876543210"
],
"timestamp": "2025-01-01T10:00:00Z"
},
"status": "success",
"status_message": "resource_found"
}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
Directory path to read from (including branch/commit info)
Body
application/json
Options for creating a data frame from a directory, including output path, columns, and commit message.
Response
Data frame created and committed
Show child attributes
Show child attributes
Example:
{
"author": "ox",
"email": "ox@example.com",
"id": "a1b2c3d4e5f67890abcdef1234567890",
"message": "Refactor data loading pipeline.",
"parent_ids": ["f1e2d3c4b5a67890fedcba9876543210"],
"timestamp": "2025-01-01T10:00:00Z"
}
⌘I