Skip to main content
GET
/
api
/
repos
/
{namespace}
/
{repo_name}
/
compare
/
{base_head}
/
entries
List file and directory entries changed between base and head
curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/entries \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "status_message": "<string>",
  "page_number": 1,
  "page_size": 1,
  "total_entries": 1,
  "total_pages": 1,
  "compare": {
    "base_commit": {
      "author": "ox",
      "email": "ox@example.com",
      "id": "a1b2c3d4e5f67890abcdef1234567890",
      "message": "Refactor data loading pipeline.",
      "parent_ids": [
        "f1e2d3c4b5a67890fedcba9876543210"
      ],
      "timestamp": "2025-01-01T10:00:00Z"
    },
    "counts": {
      "added": 1,
      "modified": 1,
      "removed": 1
    },
    "entries": [
      {
        "filename": "<string>",
        "is_dir": true,
        "size": 1,
        "status": "<string>",
        "base_entry": {
          "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>"
            }
          }
        },
        "base_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>"
          }
        },
        "diff": {
          "dir": {
            "file_counts": {
              "added": 1,
              "modified": 1,
              "removed": 1
            }
          }
        },
        "diff_summary": {
          "dir": {
            "file_counts": {
              "added": 1,
              "modified": 1,
              "removed": 1
            }
          }
        },
        "head_entry": {
          "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>"
            }
          }
        },
        "head_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>"
          }
        }
      }
    ],
    "head_commit": {
      "author": "ox",
      "email": "ox@example.com",
      "id": "a1b2c3d4e5f67890abcdef1234567890",
      "message": "Refactor data loading pipeline.",
      "parent_ids": [
        "f1e2d3c4b5a67890fedcba9876543210"
      ],
      "timestamp": "2025-01-01T10:00:00Z"
    },
    "self": {
      "filename": "<string>",
      "is_dir": true,
      "size": 1,
      "status": "<string>",
      "base_entry": {
        "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>"
          }
        }
      },
      "base_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>"
        }
      },
      "diff": {
        "dir": {
          "file_counts": {
            "added": 1,
            "modified": 1,
            "removed": 1
          }
        }
      },
      "diff_summary": {
        "dir": {
          "file_counts": {
            "added": 1,
            "modified": 1,
            "removed": 1
          }
        }
      },
      "head_entry": {
        "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>"
          }
        }
      },
      "head_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>"
        }
      }
    }
  },
  "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

​
base_head
string
required

The base and head revisions separated by '..'

Query Parameters

​
page
integer

Page number for pagination (starts at 1)

Required range: x >= 0
​
page_size
integer

Page size for pagination

Required range: x >= 0

Response

Entries found successfully

​
status
string
required
​
status_message
string
required
​
page_number
integer
required
Required range: x >= 0
​
page_size
integer
required
Required range: x >= 0
​
total_entries
integer
required
Required range: x >= 0
​
total_pages
integer
required
Required range: x >= 0
​
compare
object
required
​
oxen_version
string | null