buckets

Get bucket details

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

Request

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

Path parameters

namespacestring required
repostring required

Response

Bucket overview information

_idstring required

A hex string of 24 characters representing an ObjectId.

authorstring required
idstring required
privateboolean nullable
descriptionstring nullable

Free-text description of the bucket / container image

createdAtstring date-time required
updatedAtstring date-time required

Moves on every successful change to the bucket's files. Poll it to know when to re-list instead of re-listing every path.

sizenumber required

The amount of storage used by the bucket in bytes

totalFilesnumber required

The total number of files in the bucket

repoType'bucket' | 'container' required
adminTagsstring[]

Changes

  • ea15a26e9ab3Revision changes
    • info

      added the optional property to the response with the status

  • 74f2b0d17636Revision changes
    • breaking

      the response property const value bucket was removed for the status

    • warning

      added the new bucket enum value to the response property for the response status

    • warning

      added the new container enum value to the response property for the response status