{ "opencollection": "1.0.0", "info": { "name": "Hub API Endpoints agentic-provisioning datasets API", "version": "0.0.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "datasets", "type": "folder" }, "items": [ { "info": { "name": "Get folder size", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/treesize/:rev/:path", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get the total size of a repository at a given revision, optionally under a specific subpath. Returns the total size in bytes of all files under the specified path (recursively). If a file is stored via Xet/LFS, the LFS file size is used." }, { "info": { "name": "List Large files", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/lfs-files", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "xet", "value": "", "type": "query" } ] }, "docs": "List Xet/LFS files for a repo" }, { "info": { "name": "Delete Large files", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/lfs-files/batch", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Xet/LFS files in batch" }, { "info": { "name": "Delete Large file", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/datasets/:namespace/:repo/lfs-files/:sha", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "sha", "value": "", "type": "path" }, { "name": "rewriteHistory", "value": "", "type": "query" } ] }, "docs": "Delete a Xet/LFS file" }, { "info": { "name": "Duplicate xet files", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/lfs-files/duplicate", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Duplicate xet-stored files from this repo (source) into another repo (target) by xet hash, without re-uploading file bytes. The caller must then commit the files with their sha256/size as usual." }, { "info": { "name": "List commits", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/commits/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "p", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "List commits" }, { "info": { "name": "List references", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/refs", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "include_prs", "value": "", "type": "query" } ] }, "docs": "List references" }, { "info": { "name": "Get a compare rev", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/compare/:compare", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "compare", "value": "", "type": "path" }, { "name": "raw", "value": "", "type": "query" } ] }, "docs": "Get a compare rev" }, { "info": { "name": "List paths info", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/paths-info/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List paths info" }, { "info": { "name": "Check upload method", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/preupload/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Check if a file should be uploaded through the Large File mechanism or directly." }, { "info": { "name": "Xet write token", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/xet-write-token/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ] }, "docs": "Get a write short-lived access token for XET upload" }, { "info": { "name": "Xet read token", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/xet-read-token/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ] }, "docs": "Get a read short-lived access token for XET" }, { "info": { "name": "Commit", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/commit/:rev", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "create_pr", "value": "", "type": "query" }, { "name": "hot_reload", "value": "", "type": "query" } ] }, "docs": "For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit.\n\nJSON-lines payload:\n```json\n{\n \"key\": \"header\",\n \"value\": {\n \"summary\": \"string (REQUIRED)\",\n \"description\": \"string (OPTIONAL - defaults to empty string)\",\n \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\"\n }\n}\n{\n \"key\": \"file\",\n \"value\": {\n \"path\": \"string (REQUIRED)\",\n \"content\": \"string (OPTIONAL - required if oldPat" }, { "info": { "name": "Create tag", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/tag/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create tag" }, { "info": { "name": "Delete a tag", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/datasets/:namespace/:repo/tag/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ] }, "docs": "Delete a tag" }, { "info": { "name": "Create branch", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/branch/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create branch" }, { "info": { "name": "Delete a branch", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/datasets/:namespace/:repo/branch/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ] }, "docs": "Delete a branch" }, { "info": { "name": "Get resource group", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/resource-group", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get resource group" }, { "info": { "name": "Add resource group", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/resource-group", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add the repository to a resource group" }, { "info": { "name": "Squash ref", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/super-squash/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Squash all commits in the current ref into a single commit with the given message. Action is irreversible." }, { "info": { "name": "Update repo settings", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/datasets/:namespace/:repo/settings", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the settings of a repo" }, { "info": { "name": "List folder content", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/tree/:rev/:path", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query" }, { "name": "recursive", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List the content of a repository tree, with pagination support." }, { "info": { "name": "Get notebook URL", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/notebook/:rev/:path", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "Get a jupyter notebook URL for the requested file" }, { "info": { "name": "Get security status", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/scan", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get the security status of a repo" }, { "info": { "name": "Get the leaderboard for a dataset", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/leaderboard", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "task_id", "value": "", "type": "query" }, { "name": "max_params", "value": "", "type": "query" } ] }, "docs": "Returns the evaluation results ranked by score for a dataset/task" }, { "info": { "name": "Generate JWT", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/jwt", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "write", "value": "", "type": "query" }, { "name": "expiration", "value": "", "type": "query" }, { "name": "encrypted", "value": "", "type": "query" }, { "name": "inference_api", "value": "", "type": "query" }, { "name": "include_pro_status", "value": "", "type": "query" }, { "name": "billing_details", "value": "", "type": "query" } ] }, "docs": "Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption." }, { "info": { "name": "Get dataset tags", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets-tags-by-type", "params": [ { "name": "type", "value": "", "type": "query" } ] }, "docs": "Get all possible tags used for datasets, grouped by tag type. Optionally restrict to only one tag type" }, { "info": { "name": "Get trending", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/trending", "params": [ { "name": "type", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Get the trending repositories" }, { "info": { "name": "Resolve a file", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/datasets/:namespace/:repo/resolve/:rev/:path", "headers": [ { "name": "Range", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "This endpoint requires to follow redirection" }, { "info": { "name": "Resolve a file", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/resolve-cache/datasets/:namespace/:repo/:rev/:path", "headers": [ { "name": "Range", "value": "" }, { "name": "Accept", "value": "" } ], "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" } ] }, "docs": "This endpoint requires to follow redirection" }, { "info": { "name": "Request access", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/datasets/:namespace/:repo/ask-access", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information)" }, { "info": { "name": "Export access report", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/datasets/:namespace/:repo/user-access-report", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Export a report of all access requests for a gated repository" }, { "info": { "name": "Cancel access request", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/user-access-request/cancel", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Cancel the current user's access request to a gated repository" }, { "info": { "name": "List access requests", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/datasets/:namespace/:repo/user-access-request/:status", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "status", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "after", "value": "", "type": "query" }, { "name": "before", "value": "", "type": "query" } ] }, "docs": "List access requests for a gated repository" }, { "info": { "name": "Handle access request", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/user-access-request/handle", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Handle a user's access request to a gated repository" }, { "info": { "name": "Handle access requests in batch", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/user-access-request/batch", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Accept or reject up to 100 access requests for a single gated repository in one call. The same `status` (and optional `rejectionReason`) is applied to every request in the list." }, { "info": { "name": "Grant access", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/datasets/:namespace/:repo/user-access-request/grant", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Grant access to a user for a gated repository" } ] } ], "bundled": true }