buckets

List files

Changed on
get/api/buckets/{namespace}/{repo}/tree/{path}

Request

  • Base URL: https://huggingface.co
  • URL: https://huggingface.co/api/buckets/{namespace}/{repo}/tree/{path}
  • Auth: HTTP bearer

Path parameters

namespacestring required
repostring required
pathstring required

Wildcard path parameter

Query parameters

limitinteger
cursorstring byte

Pagination cursor

recursivestring

When false, returns collapsed directory entries instead of listing all files recursively. The number of entries returned can then be less than the limit, but there will always be a pagination link if there are more entries. Note: non-recursive listing hasn't a strong consistency guarantees.

sort'path' | 'uploadedAt'

Sort order. path (default) sorts lexicographically; uploadedAt sorts by most recent upload first. In recursive mode uploadedAt is only supported at the bucket root (no path prefix). In non-recursive mode, only supported at root or exact folder prefixes.

direction'asc' | 'desc'

Sort direction. Defaults to asc for path and desc for uploadedAt.

Response

List of files and directories

type'file' | 'directory' required
pathstring required
sizeinteger
xetHashstring

Not defined for directories

mtimestring date-time
mtimeNanosinteger

Sub-millisecond remainder of mtime, in nanoseconds (0–999_999)

uploadedAtstring date-time required
contentTypestring

Changes

  • bd17546f47b8Revision changes
    • breaking

      for the query request parameter recursive, default value true was removed

    • breaking

      the / response's property type changed from no type to string for status

    • info

      for the query request parameter direction, the type was generalized from no type to string

    • info

      for the query request parameter recursive, the type was generalized from no type to string

    • info

      for the query request parameter sort, the type was generalized from no type to string

    • info

      the / response's property pattern was changed from ^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z)$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status

    • info

      the / response's property pattern was changed from ^((\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-((0[13578]|1[02])-(0[1-9]|[12]\d|3[01])|(0[469]|11)-(0[1-9]|[12]\d|30)|(02)-(0[1-9]|1\d|2[0-8])))T([01]\d|2[0-3]):[0-5]\d:[0-5]\d(\.\d+)?(Z)$ to ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$ for the status