Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
data_frames
/
{resource}
Get data frame slice
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/data_frames/{resource} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "status_message": "<string>",
  "data_frame": {
    "source": {
      "schema": {
        "fields": [
          {
            "dtype": "<string>",
            "name": "<string>",
            "changes": "<unknown>",
            "metadata": "<unknown>"
          }
        ],
        "hash": "<string>",
        "metadata": "<unknown>"
      },
      "size": {
        "height": 1,
        "width": 1
      }
    },
    "view": {
      "opts": [
        {
          "name": "<string>",
          "value": "<unknown>"
        }
      ],
      "data": "<unknown>",
      "pagination": {
        "page_number": 1,
        "page_size": 1,
        "total_entries": 1,
        "total_pages": 1
      },
      "schema": {
        "fields": [
          {
            "dtype": "<string>",
            "name": "<string>",
            "changes": "<unknown>",
            "metadata": "<unknown>"
          }
        ],
        "hash": "<string>",
        "metadata": "<unknown>"
      },
      "size": {
        "height": 1,
        "width": 1
      }
    }
  },
  "oxen_version": "<string>",
  "commit": "<unknown>",
  "derived_resource": "<unknown>",
  "resource": "<unknown>"
}

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 tabular file (including branch/commit info)

​
columns
string | null
required
​
delimiter
string | null
required
​
find_embedding_where
string | null
required
​
filter
string | null
required
​
output
string | null
required
​
output_column
string | null
required
​
page_size
integer | null
required
Required range: x >= 0
​
page
integer | null
required
Required range: x >= 0
​
row
integer | null
required
Required range: x >= 0
​
randomize
boolean | null
required
​
reverse
boolean | null
required
​
slice
string | null
required
​
sort_by
string | null
required
​
sort_by_similarity_to
string | null
required
​
sql
string | null
required
​
take
string | null
required

Response

Data frame slice found

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