List changed files

List the files and sub-directories within a directory that have changed within a provided commit range.

GET /api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries

List changed files

cURL

curl --request GET \
  --url https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries', 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}/compare/{base_head}/dir/{dir}/entries",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://hub.oxen.ai/api/repos/{namespace}/{repo_name}/compare/{base_head}/dir/{dir}/entries")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "status": "<string>",
  "status_message": "<string>",
  "page_number": 1,
  "page_size": 1,
  "total_entries": 1,
  "total_pages": 1,
  "compare": {
    "base_commit": {
      "author": "ox",
      "email": "[e-mail]",
      "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": "[e-mail]",
            "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": "[e-mail]",
              "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": "[e-mail]",
                "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>"
            }
          }
        },
        "base_resource": {
          "path": "<string>",
          "resource": "<string>",
          "version": "<string>",
          "branch": {
            "commit_id": "<string>",
            "name": "<string>"
          },
          "commit": {
            "author": "ox",
            "email": "[e-mail]",
            "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": "[e-mail]",
              "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>"
          }
        },
        "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": "[e-mail]",
            "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": "[e-mail]",
              "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": "[e-mail]",
                "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>"
            }
          }
        },
        "head_resource": {
          "path": "<string>",
          "resource": "<string>",
          "version": "<string>",
          "branch": {
            "commit_id": "<string>",
            "name": "<string>"
          },
          "commit": {
            "author": "ox",
            "email": "[e-mail]",
            "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": "[e-mail]",
              "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>"
          }
        }
      }
    ],
    "head_commit": {
      "author": "ox",
      "email": "[e-mail]",
      "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": "[e-mail]",
          "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": "[e-mail]",
            "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": "[e-mail]",
              "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>"
          }
        }
      },
      "base_resource": {
        "path": "<string>",
        "resource": "<string>",
        "version": "<string>",
        "branch": {
          "commit_id": "<string>",
          "name": "<string>"
        },
        "commit": {
          "author": "ox",
          "email": "[e-mail]",
          "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": "[e-mail]",
            "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>"
        }
      },
      "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": "[e-mail]",
          "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": "[e-mail]",
            "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": "[e-mail]",
              "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>"
          }
        }
      },
      "head_resource": {
        "path": "<string>",
        "resource": "<string>",
        "version": "<string>",
        "branch": {
          "commit_id": "<string>",
          "name": "<string>"
        },
        "commit": {
          "author": "ox",
          "email": "[e-mail]",
          "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": "[e-mail]",
            "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

base_head · string · required

The base and head revisions separated by '..'

dir · string · required

The directory path to list entries for

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

200

application/json

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

Show child attributes

oxen_version · string | null