Skip to main content
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": "[email protected]",
  "user_name": "Bessie"
}
'
{
  "commit": {
    "author": "ox",
    "email": "[email protected]",
    "id": "a1b2c3d4e5f67890abcdef1234567890",
    "message": "Refactor data loading pipeline.",
    "parent_ids": [
      "f1e2d3c4b5a67890fedcba9876543210"
    ],
    "timestamp": "2025-01-01T10:00:00Z"
  },
  "status": "success",
  "status_message": "resource_found"
}

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

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.

​
commit_message
string | null
​
extra_columns
object[] | null
​
output_path
string | null
​
recursive
boolean | null
​
user_email
string | null
​
user_name
string | null

Response

Data frame created and committed

​
status
string
required
​
status_message
string
required
​
commit
object
required
Example:
{
  "author": "ox",
  "email": "[email protected]",
  "id": "a1b2c3d4e5f67890abcdef1234567890",
  "message": "Refactor data loading pipeline.",
  "parent_ids": ["f1e2d3c4b5a67890fedcba9876543210"],
  "timestamp": "2025-01-01T10:00:00Z"
}
​
oxen_version
string | null