Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
metadata
/
{resource}
Get file metadata
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/metadata/{resource} \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "status_message": "<string>",
  "entry": {
    "data_type": "dir",
    "extension": "<string>",
    "filename": "<string>",
    "hash": "<string>",
    "is_dir": true,
    "mime_type": "<string>",
    "size": 1,
    "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": {
        "base_repo": {
          "path": "<string>",
          "remotes": [
            {
              "name": "<string>",
              "url": "<string>"
            }
          ],
          "depth": 123,
          "min_version": "<string>",
          "remote_mode": true,
          "remote_name": "<string>",
          "subtree_paths": [
            "<string>"
          ],
          "vfs": true,
          "vnode_size": 1,
          "workspace_name": "<string>",
          "workspaces": [
            "<string>"
          ]
        },
        "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>",
        "is_editable": true,
        "workspace_repo": {
          "path": "<string>",
          "remotes": [
            {
              "name": "<string>",
              "url": "<string>"
            }
          ],
          "depth": 123,
          "min_version": "<string>",
          "remote_mode": true,
          "remote_name": "<string>",
          "subtree_paths": [
            "<string>"
          ],
          "vfs": true,
          "vnode_size": 1,
          "workspace_name": "<string>",
          "workspaces": [
            "<string>"
          ]
        },
        "name": "<string>"
      }
    }
  },
  "oxen_version": "<string>"
}

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

Response

Metadata for the entry found

status
string
required
status_message
string
required
entry
object
required
oxen_version
string | null