Hugging Face

Delete bucket

Delete a collection

Delete a collection

Delete an item from a collection

Delete an item from a collection

Delete a branch

Delete a Xet/LFS file

Delete a tag

Delete a branch

Delete a Xet/LFS file

Delete a tag

Delete notifications, either by specifying discussionIds or by applying to all notifications with search parameters

Delete a resource group from the organization. Requires the org to have a Team plan or higher.

Remove a user from a resource group, revoking the access granted through it. Requires the org to have a Team plan or higher.

Delete a SCIM group

Removes a user from the organization and deletes any pending invitations for non-managed organizations.

Delete a SCIM group

Delete a SCIM user

Delete a service account and all its tokens. This action cannot be undone.

Delete an access token from a service account. This action cannot be undone.

Delete a discussion

Delete a discussion

Deletes the git ref for a closed/merged pull request to free up storage. LFS files unique to this PR will be garbage collected. The PR page and diff will still be viewable using stored commit data.

Delete SQL Console embed

Delete a scheduled job

Delete webhook

Delete a branch

Delete a Xet/LFS file

Delete Spaces's secret

Delete a tag

Delete Spaces's variable

Delete Space volumes

Get the registry of AI agents / harnesses known to the Hub, along with the standard environment variables used to detect them. Clients use this registry to identify which agent they are running in when reporting Hub activity.

Get health

Get a resource by ID

Get services

Display the avatar for any user or organization. This endpoint redirects to the avatar URL for either a user or an organization

List namespace buckets

Get bucket details

Get resource group

List files

Get a read short-lived access token for XET

Get a write short-lived access token for XET upload

Get collections

Get a collection

Get a collection

Get collection resource group

Get collection resource group

Get Daily Papers

List commits

Get a compare rev

Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.

Returns the evaluation results ranked by score for a dataset/task

List Xet/LFS files for a repo

Get a jupyter notebook URL for the requested file

List references

Get resource group

Get the security status of a repo

List the content of a repository tree, with pagination support.

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.

List access requests for a gated repository

Get a read short-lived access token for XET

Get a write short-lived access token for XET upload

Get all possible tags used for datasets, grouped by tag type. Optionally restrict to only one tag type

Get list of available documentation

Search any Hugging Face documentation

Full-text search across Hugging Face documentation

Get available job hardware

List of jobs for an entity

Count the number of jobs for an entity with optional status stage filter

Get a job

Stream the events of a job, using SSE

Stream the logs of a job, using SSE

Stream the metrics of a job, using SSE

List kernels with optional filtering, sorting, and pagination

Get kernel

Get kernel

List commits

Get a compare rev

Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.

List Xet/LFS files for a repo

Get a jupyter notebook URL for the requested file

List references

Get resource group

Get the security status of a repo

List the content of a repository tree, with pagination support.

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.

List access requests for a gated repository

Get a read short-lived access token for XET

Get a write short-lived access token for XET upload

Get all possible tags used for models, grouped by tag type. Optionally restrict to only one tag type

List notifications for the user

Export the audit log events in JSON format for a Team or Enterprise organization. The export is limited to the last 100,000 events.

Retrieve organization avatar. This endpoint returns a JSON with the avatar URL for the organization. If called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL

Get org usage for a given period

Get org inference-provider usage broken down per session id, as a time-series of monthly periods.

Get org usage breakdown per resource group, returned as a time-series of monthly periods. Window is [startDate, endDate], defaults to the current month. Both dates must fall within the last 12 months. Storage values are the peak observed within each monthly period.

Get live usage for org

Get org usage for a given period

Get a list of members for the organization with optional search and pagination.

Retrieve accessible resource groups. Get all resource groups the user has access to. Requires the org to have a Team plan or higher.

Retrieve a single resource group by id. Requires the org to have a Team plan or higher.

Get a list of SCIM groups. Retrieves a paginated list of all organization groups. If you provide the filter parameter, the resources for all matching groups are returned.

Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned.

Retrieves a paginated list of organization members and pending invitations managed by SCIM for non-managed organizations.

Retrieves a SCIM user by their ID for non-managed organizations.

Get a list of SCIM groups. Retrieves a paginated list of all organization groups. If you provide the filter parameter, the resources for all matching groups are returned.

Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned.

Returns the list of SCIM 2.0 resource types supported by this server (User and Group).

Returns the SCIM 2.0 schema definitions for User and Group resources.

Returns a single SCIM 2.0 schema definition by its schema URI.

Returns the SCIM 2.0 Service Provider configuration, describing the server's capabilities and supported authentication schemes.

Retrieves a paginated list of all organization members who have been set up, including disabled users. If you provide the filter parameter, the resources for all matching members are returned.

Retrieves a SCIM user by their ID.

List all service accounts for the organization.

Retrieve a single service account and its access token metadata. Token secrets are never returned.

Get the network security settings for an organization.

List organization repositories

Get an organization's social media handles

List arXiv papers sorted by published date

Get a paper

Perform a hybrid semantic / full-text-search on papers

Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets

Mints a short-lived EdDSA JWT for the HuggingFace container registry, verifiable via the JWK at `/api/keys/jwt`.

Get discussions for a repo

Get discussion details

Estimates the LFS storage used by a PR that could be freed if the ref is deleted.

This endpoint requires to follow redirection

This endpoint requires to follow redirection

This endpoint requires to follow redirection

List scheduled jobs for an entity

Get a scheduled job

Get user usage for a given period

Get user inference-provider usage broken down per session id

Get user Jobs usage for current subscription period

Get live usage for user

Get user usage for a given period

Get the MCP tools for the current user

Get live usage and running jobs count for the logged-in user, over a single SSE connection

List user repositories

List webhooks

Get webhook

Get available space hardware

List commits

Get a compare rev

Get status updates for a specific Space in a streaming fashion, with SSE protocol

Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.

List Xet/LFS files for a repo

Get logs for a specific Space in a streaming fashion, with SSE protocol

Get live metrics for a specific Space in a streaming fashion, with SSE protocol, such as current Zero-GPU usage

Get a jupyter notebook URL for the requested file

List references

Get resource group

Get the security status of a repo

List a Space's secret keys. Values are never returned.

List the content of a repository tree, with pagination support.

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.

List a Space's variables with their values.

Get a read short-lived access token for XET

Get a write short-lived access token for XET upload

Returns the catalog of official Space templates. The `repoId` of a template can be passed as `template` when creating a Space through the create-repo endpoint.

Get the authenticated user's current ZeroGPU quota usage and limits

Get the trending repositories

This endpoint returns a JSON with the avatar URL for the user. If called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL

Get live usage for user

List public repos liked by a user

User overview

Get a user's social media handles

Get information about the user and auth method used

Returns file metadata including size, hash, and links to XET authentication

This endpoint requires to follow redirection

Export a report of all access requests for a gated repository

This endpoint requires to follow redirection

Export a report of all access requests for a gated repository

Get information about the user. Only available through oauth access tokens. Information varies depending on the scope of the oauth app and what permissions the user granted to the oauth app.

This endpoint requires to follow redirection

Update a collection

Update a collection

Update the name and/or description of a resource group. Requires the org to have a Team plan or higher.

Change the role of a user in a resource group. Requires the org to have a Team plan or higher.

Update attributes of a SCIM group. Updates individual attributes using Operations format. Just provide the changes you want to make using add, remove (only `members` is supported), or replace operations.

Modify individual attributes for non-managed organizations. Only the `active` field can be modified. User profile fields are not editable via SCIM.

Update attributes of a SCIM group. Updates individual attributes using Operations format. Just provide the changes you want to make using add, remove (only `members` is supported), or replace operations.

Update an attribute of a SCIM user. Modify individual attributes using Operations format. Just provide the changes you want to make using add, remove (only `externalId` is supported), or replace operations. If you set `active` to `false`, the user will be deprovisioned from the organization. Complicated SCIM `path` values are not supported like `emails[type eq 'work'].value`.

Update the name and/or permissions of an existing service account token.

Update the network security settings for an organization.

Update SQL Console embed

Update notification settings for the user

Update watch settings for the user. Get notified when discussions happen on your watched items.

Create account request

Create deep link

Provision a resource

Remove resource

Rotate resource credentials

Update resource service

Create a new comment

Create a new comment

Create a new comment

Create a new comment

Create bucket

Accepts NDJSON (newline-delimited JSON) where each line is an addFile, copyFile, or deleteFile instruction. All add/copy operations must come before all delete operations. JSON-lines payload: ```json '{"type":"addFile","path":"...","xetHash":"...","mtime":...,"mtimeNanos":...,"contentType":"..."}' + '{"type":"copyFile","path":"...","xetHash":"...","sourceRepoType":"...","sourceRepoId":"...","mtime":...,"mtimeNanos":...,"contentType":"..."}' + '{"type":"deleteFile","path":"..."}' ```

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.

List paths info

Add the repository to a resource group

Create a collection

Add an item to a collection

Batch update items in a collection

Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible.

Add an item to a collection

Batch update items in a collection

Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible.

Publicly invalidate leaked Hugging Face access tokens. Possession of the raw token value is the only proof required: no authentication is needed, and no rights over the owning account or org are necessary. Each raw token is fully invalidated, the owning user is notified by email. Always returns 202, whether or not any of the provided tokens existed, so the response cannot be used to probe token validity.

Create branch

For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { "key": "header", "value": { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" } } { "key": "file", "value": { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } { "key": "deletedEntry", "value": { "path": "string (REQUIRED)" } } { "key": "lfsFile", "value": { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } ``` JSON payload: ```json { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" "files": [ { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ], "deletedEntries": [ { "path": "string (REQUIRED)" } ], "lfsFiles": [ { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ] } ```

Delete Xet/LFS files in batch

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.

List paths info

Check if a file should be uploaded through the Large File mechanism or directly.

Add the repository to a resource group

Squash all commits in the current ref into a single commit with the given message. Action is irreversible.

Create tag

Accept, reject or reset to pending 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.

Cancel the current user's access request to a gated repository

Grant access to a user for a gated repository

Handle a user's access request to a gated repository

Check if the user has access to the inference endpoint

Check if the user has access to the inference endpoint

Start a job

Check if the user has access to jobs in the namespace

Check if the user has access to jobs in the namespace

Cancel a job

Duplicate an existing job, re-using its spec

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.

Create branch

For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { "key": "header", "value": { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" } } { "key": "file", "value": { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } { "key": "deletedEntry", "value": { "path": "string (REQUIRED)" } } { "key": "lfsFile", "value": { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } ``` JSON payload: ```json { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" "files": [ { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ], "deletedEntries": [ { "path": "string (REQUIRED)" } ], "lfsFiles": [ { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ] } ```

Delete Xet/LFS files in batch

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.

List paths info

Check if a file should be uploaded through the Large File mechanism or directly.

Add the repository to a resource group

Squash all commits in the current ref into a single commit with the given message. Action is irreversible.

Create tag

Accept, reject or reset to pending 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.

Cancel the current user's access request to a gated repository

Grant access to a user for a gated repository

Handle a user's access request to a gated repository

Mark discussions as read or unread. If `applyToAll` is true, all notifications for the user matching the search parameters will be marked as read or unread.

Create a new resource group in the organization. Requires the org to have a Team plan or higher.

Configure the auto-join settings of a resource group. Requires the org to have a Team plan or higher.

Add one or more organization members to a resource group. Requires the org to have a Team plan or higher.

Creates a new group in the organization. The group name must be unique within the organization.

Creates an invitation for a user to join the organization. The user must have an existing Hugging Face account.

Creates a new group in the organization. The group name must be unique within the organization.

Creates a new user in the organization. If the user already exists, only `active` field will be updated to provision the user.

Create a new service account for the organization.

Create a new access token for a service account. Store the token securely - it cannot be retrieved later.

Invalidate an existing token and generate a new one with the same permissions. The old token will stop working immediately.

An org admin can revoke a token's access to the org. The token itself isn't deleted, it still works outside the org. Requires the raw token value. Enterprise only.

Index a paper from arXiv by its ID. If the paper is already indexed, only its authors can re-index it.

Create a new comment

Create a new comment

Update the project page, GitHub repository, or submitting organization for a paper. Requires the requester to be the paper author, the Daily Papers submitter, or a papers admin.

Create a new comment

Create a new comment

Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets

Create a new discussion

Create a new comment

Merge a pull request

Pin a discussion

Change the status of a discussion

Change the title of a discussion

Duplicate a repository

Create SQL Console embed

Create a new repository

Move or rename a repo

Create a scheduled job

Resume a scheduled job

Trigger a scheduled job run. Trigger a scheduled job to run immediately. Throws an error if an instance is already running and job spec does not allow concurrent runs.

Update job schedule

Suspend a scheduled job

Claim paper authorship

Create webhook

Update webhook

Enable/disable webhook

Replay webhook log

Create branch

For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { "key": "header", "value": { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" } } { "key": "file", "value": { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } { "key": "deletedEntry", "value": { "path": "string (REQUIRED)" } } { "key": "lfsFile", "value": { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } } ``` JSON payload: ```json { "summary": "string (REQUIRED)", "description": "string (OPTIONAL - defaults to empty string)", "parentCommit": "string (OPTIONAL - 40-character hex SHA)" "files": [ { "path": "string (REQUIRED)", "content": "string (OPTIONAL - required if oldPath not set)", "encoding": "utf-8 | base64 (OPTIONAL - defaults to utf-8)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ], "deletedEntries": [ { "path": "string (REQUIRED)" } ], "lfsFiles": [ { "path": "string (REQUIRED - max 1000 chars)", "oid": "string (OPTIONAL - required if oldPath not set, 64 hex chars)", "algo": "sha256 (OPTIONAL - only sha256 supported)", "size": "number (OPTIONAL - required if oldPath is set)", "oldPath": "string (OPTIONAL - for move/rename operations)" } ] } ```

Delete Xet/LFS files in batch

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.

List paths info

Check if a file should be uploaded through the Large File mechanism or directly.

Add the repository to a resource group

Upsert Spaces's secret

Squash all commits in the current ref into a single commit with the given message. Action is irreversible.

Create tag

Upsert Spaces's variable

Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information)

Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information)

Initiate device authorization

Register a new OAuth app

Get information about the user. Only available through oauth access tokens. Information varies depending on the scope of the oauth app and what permissions the user granted to the oauth app.

Update bucket settings

Update the settings of a repo

Replace the exposed ports of a running job, applied live (no re-run). Ports listed in `portsPublic` are reachable without any authentication.

Replace user-provided labels on a job

Update the settings of a repo

Change the role of a member in the organization. Need a paid plan.

Updates a group by its ID. The group name must be unique within the organization.

Updates a provisioned user's invitation for non-managed organizations. User profile fields are not editable via SCIM for non-managed organizations.

Updates a group by its ID. The group name must be unique within the organization.

Updates a provisioned user, you'll need to provide all their information fresh - just like setting them up for the first time. Any details you don't include will be automatically removed, so make sure to include everything they need to keep their account running smoothly. Setting `active` to `false` will deprovision the user from the organization.

Replace user-provided labels on a scheduled job

Update the settings of a repo

Set Space volumes