Hugging Face integration: operations for AI agents
Hugging Face connects to Type.com as an integration. This page lists the 374 operations documented for Claude and Codex in Type.com: 166 read, 124 write, 84 destructive.
About Hugging Face
Hugging Face Hub vendor API references, subject to vendor permissions and account availability.
Categories: Developer Tools & IT
How to connect Hugging Face to Type.com
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
374 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
374 operations listed.
notifications
- Read
List notifications
List notifications for the user
GET /api/notifications - Write
Change read status
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.
POST /api/notifications/mark-as-read - Write
Update notification settings
Update notification settings for the user
PATCH /api/settings/notifications - Write
Update watch settings
Update watch settings for the user. Get notified when discussions happen on your watched items.
PATCH /api/settings/watch - Destructive
Delete notifications
Delete notifications, either by specifying discussionIds or by applying to all notifications with search parameters
DELETE /api/notifications
tokens
- Destructive
Revoke leaked tokens
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.
POST /api/credentials/revoke
users
- Read
Get MCP tools
Get the MCP tools for the current user
GET /api/settings/mcp - Read
List user repositories
List user repositories
GET /api/settings/repositories - Read
Get user usage
Get user usage for a given period
GET /api/settings/billing/usage-v2 - Read
Session inference usage
Get user inference-provider usage broken down per session id
GET /api/settings/billing/usage-by-inference-session - Read
Get jobs usage
Get user Jobs usage for current subscription period
GET /api/settings/billing/usage/jobs - Read
Stream usage
Get live usage for user
GET /api/settings/billing/usage/live - Read
Stream metrics
Get live usage and running jobs count for the logged-in user, over a single SSE connection
GET /api/settings/metrics/live - Read
Stream usage
Get live usage for user
GET /api/users/{username}/billing/usage/live - Read
User overview
User overview
GET /api/users/{username}/overview - Read
Get social handles
Get a user's social media handles
GET /api/users/{username}/socials - Read
Retrieve user avatar
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 /api/users/{username}/avatar - Read
List user likes
List public repos liked by a user
GET /api/users/{username}/likes - Read
List user followers
List user followers
GET /api/users/{username}/followers - Read
List followed users
List followed users
GET /api/users/{username}/following - Read
List followed organizations
List followed organizations
GET /api/users/{username}/following/orgs - Read
Get avatar
Display the avatar for any user or organization. This endpoint redirects to the avatar URL for either a user or an organization
GET /api/avatars/{namespace}
webhooks
- Read
List webhooks
List webhooks
GET /api/settings/webhooks - Read
Get webhook
Get webhook
GET /api/settings/webhooks/{webhookId} - Write
Create webhook
Create webhook
POST /api/settings/webhooks - Destructive
Update webhook
Update webhook
POST /api/settings/webhooks/{webhookId} - Destructive
Delete webhook
Delete webhook
DELETE /api/settings/webhooks/{webhookId} - Destructive
Enable/disable webhook
Enable/disable webhook
POST /api/settings/webhooks/{webhookId}/{action} - Destructive
Replay webhook log
Replay webhook log
POST /api/settings/webhooks/{webhookId}/replay/{logId}
papers
- Read
Get Daily Papers
Get Daily Papers
GET /api/daily_papers - Read
List papers
List arXiv papers sorted by published date
GET /api/papers - Read
Search papers
Perform a hybrid semantic / full-text-search on papers
GET /api/papers/search - Read
Get a paper
Get a paper
GET /api/papers/{paperId} - Write
Claim paper authorship
Claim paper authorship
POST /api/settings/papers/claim - Write
Index a paper
Index a paper from arXiv by its ID. If the paper is already indexed, only its authors can re-index it.
POST /api/papers/index - Write
Update paper links
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.
POST /api/papers/{paperId}/links - Destructive
Update paper media
Replace the media shown on a Daily Papers submission. Requires the requester to be the paper author, the Daily Papers submitter, or a papers admin.
POST /api/papers/{paperId}/media
inference-providers
- Read
List provider mappings
List the model mappings of an inference provider.
GET /api/partners/{provider}/models - Write
Reorder inference providers
Reorder inference providers
POST /api/settings/inference-providers - Write
Set provider key
Set provider key
POST /api/settings/inference-providers/api-key - Write
Default billing entity
Default billing entity
PUT /api/settings/inference-providers/default-billing-entity - Write
Set spending limit
Set spending limit
PUT /api/settings/inference-providers/usage-limits - Write
Create provider mapping
Register a model mapping for your inference provider. Requires a write token of the provider organization.
POST /api/partners/{provider}/models - Write
Update mapping status
Update the status of one of your inference provider's model mappings.
PUT /api/partners/{provider}/models/{mappingId}/status
orgs
- Read
Member access tokens
List the access tokens of the organization's members. Team or Enterprise only.
GET /api/organizations/{name}/settings/tokens - Read
List organization repositories
List organization repositories
GET /api/organizations/{name}/settings/repositories - Read
Export audit log
Export the audit log events in JSON format for a Team or Enterprise organization. The export is limited to the last 100,000 events.
GET /api/organizations/{name}/audit-log/export - Read
Network security settings
Get the network security settings for an organization.
GET /api/organizations/{name}/settings/network-security - Read
Get avatar
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 /api/organizations/{name}/avatar - Read
Get organization members
Get a list of members for the organization with optional search and pagination.
GET /api/organizations/{name}/members - Read
Get org usage
Get org usage for a given period
GET /api/organizations/{name}/billing/usage-v2 - Read
Resource group usage
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 /api/organizations/{name}/billing/usage-by-resource-group - Read
Session inference usage
Get org inference-provider usage broken down per session id, as a time-series of monthly periods.
GET /api/organizations/{name}/billing/usage-by-inference-session - Read
Inference usage
Get org inference-provider usage per member, model and provider, returned as a time-series of daily periods. Window is [startDate, endDate], defaults to the current month. Both dates must fall within the last 12 months. Returns up to `limit` periods, follow the `Link` header for the next ones. Requests are included up to 2 hours after they are made.
GET /api/organizations/{name}/billing/usage/inference - Read
Stream usage
Get live usage for org
GET /api/organizations/{name}/billing/usage/live - Read
Get social handles
Get an organization's social media handles
GET /api/organizations/{name}/socials - Write
Rotate SSO credentials
Update SSO credentials of the organization's SSO configuration. SSO stays enabled and does not need to be re-tested, so rotation causes no downtime. Requires a paid plan.
PUT /api/organizations/{name}/settings/sso/credentials - Write
Update network security
Update the network security settings for an organization.
PATCH /api/organizations/{name}/settings/network-security - Write
Change member role
Change the role of a member in the organization. Need a paid plan.
PUT /api/organizations/{name}/members/{username}/role - Write
Change account type
Convert a member into an external collaborator, who isn't required to sign in with SSO, or back into a member. Need a paid plan. Doesn't affect the role, which must be changed separately.
PUT /api/organizations/{name}/members/{username}/account-type - Destructive
Revoke member token
An org admin can revoke a token's access to the org. The token itself isn't deleted, it still works outside the org. The token id is the one displayed in the org token settings page or through the tokens listing API endpoint. Enterprise only.
POST /api/organizations/{name}/settings/tokens/{tokenId}/revoke
resource-groups
- Read
Get resource group
Retrieve a single resource group by id. Requires the org to have a Team plan or higher.
GET /api/organizations/{name}/resource-groups/{resourceGroupId} - Read
List pending invitations
List pending invitations
GET /api/organizations/{name}/resource-groups/{resourceGroupId}/invitations - Read
Get resource groups
Retrieve accessible resource groups. Get all resource groups the user has access to. Requires the org to have a Team plan or higher.
GET /api/organizations/{name}/resource-groups - Read
Get resource group settings
Retrieve the org-wide resource group settings: who may create resource groups, and whether resource group admins may invite users from outside the org. Requires the org to have a Team plan or higher.
GET /api/organizations/{name}/resource-groups/settings - Write
Configure auto-join
Configure the auto-join settings of a resource group. Requires the org to have a Team plan or higher.
POST /api/organizations/{name}/resource-groups/{resourceGroupId}/settings - Write
Add users
Add one or more organization members to a resource group. Use the `inherit` role to give a member the same role they have in the organization, following it when it changes. Requires the org to have a Team plan or higher.
POST /api/organizations/{name}/resource-groups/{resourceGroupId}/users - Write
Invite external user
Invite a user who is not yet an organization member into a resource group. On accepting, they only get access to that resource group, with the requested read or write role. Requires external invites to be enabled in the organization's resource group settings, unless the caller is an organization admin.
POST /api/organizations/{name}/resource-groups/{resourceGroupId}/invite - Write
Resend invitation
Resend invitation
POST /api/organizations/{name}/resource-groups/{resourceGroupId}/invitation/{id}/resend - Write
Create resource group
Create a new resource group in the organization. Requires the org to have a Team plan or higher.
POST /api/organizations/{name}/resource-groups - Write
Update resource group settings
Update the org-wide resource group settings. Omitted fields are left unchanged. Enabling `allowExternalInvites` lets resource group admins add members to the org, consuming billable seats. Requires the org to have a Team plan or higher.
POST /api/organizations/{name}/resource-groups/settings - Destructive
Update resource group
Update the name, description and/or monthly spend limits (in cents, `null` to remove) of a resource group. `spendLimits.total` caps the group's combined spend across every product; the per-product limits cap each product on top of it. Requires the org to have a Team plan or higher.
PATCH /api/organizations/{name}/resource-groups/{resourceGroupId} - Destructive
Delete resource group
Delete a resource group from the organization. Requires the org to have a Team plan or higher.
DELETE /api/organizations/{name}/resource-groups/{resourceGroupId} - Destructive
Revoke invitation
Revoke invitation
DELETE /api/organizations/{name}/resource-groups/{resourceGroupId}/invitation/{id} - Destructive
Remove user
Remove a user from a resource group, revoking the access granted through it. Requires the org to have a Team plan or higher.
DELETE /api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username} - Destructive
Change user role
Change the role of a user in a resource group. In a SCIM-managed resource group, pass `resetToScimRole` to undo a manual role change and restore the role mapped from the user's SCIM groups. Use the `inherit` role to give the member the same role they have in the organization, following it when it changes. Requires the org to have a Team plan or higher.
PATCH /api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
service-accounts
- Read
List service accounts
List all service accounts for the organization.
GET /api/organizations/{name}/service-accounts - Read
Get service account
Retrieve a single service account and its access token metadata. Token secrets are never returned.
GET /api/organizations/{name}/service-accounts/{serviceAccountId} - Write
Create service account
Create a new service account for the organization.
POST /api/organizations/{name}/service-accounts - Write
Create service-account token
Create a new access token for a service account. Store the token securely - it cannot be retrieved later.
POST /api/organizations/{name}/service-accounts/{serviceAccountId}/tokens - Destructive
Delete service account
Delete a service account and all its tokens. This action cannot be undone.
DELETE /api/organizations/{name}/service-accounts/{serviceAccountId} - Destructive
Delete service-account token
Delete an access token from a service account. This action cannot be undone.
DELETE /api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId} - Destructive
Update service-account token
Update the name and/or permissions of an existing service account token.
PATCH /api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId} - Destructive
Rotate service-account token
Invalidate an existing token and generate a new one with the same permissions. The old token will stop working immediately.
POST /api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}/rotate
scim
- Read
Get SCIM Configuration
Returns the SCIM 2.0 Service Provider configuration, describing the server's capabilities and supported authentication schemes.
GET /api/organizations/{name}/scim/v2/ServiceProviderConfig - Read
SCIM resource types
Returns the list of SCIM 2.0 resource types supported by this server (User and Group).
GET /api/organizations/{name}/scim/v2/ResourceTypes - Read
Get SCIM Schemas
Returns the SCIM 2.0 schema definitions for User and Group resources.
GET /api/organizations/{name}/scim/v2/Schemas - Read
Get SCIM schema
Returns a single SCIM 2.0 schema definition by its schema URI.
GET /api/organizations/{name}/scim/v2/Schemas/{schemaId} - Read
List SCIM users
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.
GET /api/organizations/{name}/scim/v2/Users - Read
Get SCIM user
Retrieves a SCIM user by their ID.
GET /api/organizations/{name}/scim/v2/Users/{userId} - Read
List SCIM groups
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.
GET /api/organizations/{name}/scim/v2/Groups - Read
Get SCIM group
Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned.
GET /api/organizations/{name}/scim/v2/Groups/{groupId} - Read
List SCIM-managed users
Retrieves a paginated list of organization members and pending invitations managed by SCIM for non-managed organizations.
GET /api/organizations/{name}/scim-provisioning/v2/Users - Read
SCIM provisioning user
Retrieves a SCIM user by their ID for non-managed organizations.
GET /api/organizations/{name}/scim-provisioning/v2/Users/{userId} - Read
List SCIM groups
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.
GET /api/organizations/{name}/scim-provisioning/v2/Groups - Read
Get SCIM group
Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned.
GET /api/organizations/{name}/scim-provisioning/v2/Groups/{groupId} - Write
Create SCIM user
Creates a new user in the organization. If the user already exists, only `active` field will be updated to provision the user.
POST /api/organizations/{name}/scim/v2/Users - Write
Create SCIM group
Creates a new group in the organization. The group name must be unique within the organization.
POST /api/organizations/{name}/scim/v2/Groups - Write
Create SCIM invitation
Creates an invitation for a user to join the organization. The user must have an existing Hugging Face account.
POST /api/organizations/{name}/scim-provisioning/v2/Users - Write
Create SCIM group
Creates a new group in the organization. The group name must be unique within the organization.
POST /api/organizations/{name}/scim-provisioning/v2/Groups - Destructive
Update SCIM user
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`.
PATCH /api/organizations/{name}/scim/v2/Users/{userId} - Destructive
Update SCIM user
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.
PUT /api/organizations/{name}/scim/v2/Users/{userId} - Destructive
Delete SCIM user
Delete SCIM user
DELETE /api/organizations/{name}/scim/v2/Users/{userId} - Destructive
Update SCIM group
Updates a group by its ID. The group name must be unique within the organization.
PUT /api/organizations/{name}/scim/v2/Groups/{groupId} - Destructive
Update SCIM group
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.
PATCH /api/organizations/{name}/scim/v2/Groups/{groupId} - Destructive
Delete SCIM group
Delete SCIM group
DELETE /api/organizations/{name}/scim/v2/Groups/{groupId} - Destructive
Update SCIM user
Modify individual attributes for non-managed organizations. Only the `active` field can be modified. User profile fields are not editable via SCIM.
PATCH /api/organizations/{name}/scim-provisioning/v2/Users/{userId} - Destructive
Update SCIM user
Updates a provisioned user's invitation for non-managed organizations. User profile fields are not editable via SCIM for non-managed organizations.
PUT /api/organizations/{name}/scim-provisioning/v2/Users/{userId} - Destructive
Delete SCIM user
Removes a user from the organization and deletes any pending invitations for non-managed organizations.
DELETE /api/organizations/{name}/scim-provisioning/v2/Users/{userId} - Destructive
Update SCIM group
Updates a group by its ID. The group name must be unique within the organization.
PUT /api/organizations/{name}/scim-provisioning/v2/Groups/{groupId} - Destructive
Update SCIM group
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.
PATCH /api/organizations/{name}/scim-provisioning/v2/Groups/{groupId} - Destructive
Delete SCIM group
Delete SCIM group
DELETE /api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}
oauth
- Read
Get user info
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.
GET /oauth/userinfo - Write
Register OAuth app
Register OAuth app
POST /oauth/register - Write
Initiate device authorization
Initiate device authorization
POST /oauth/device - Write
Get user info
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.
POST /oauth/userinfo
containers
- Read
Registry token
Mints a short-lived EdDSA JWT for the HuggingFace container registry, verifiable via the JWK at `/api/keys/jwt`.
GET /api/registry/token - Read
Xet write token
Get a write short-lived access token for XET upload
GET /api/containers/{namespace}/{repo}/xet-write-token - Read
Xet read token
Get a read short-lived access token for XET
GET /api/containers/{namespace}/{repo}/xet-read-token - Read
Get bucket details
Get bucket details
GET /api/containers/{namespace}/{repo} - Read
List namespace buckets
List namespace buckets
GET /api/containers/{namespace} - Read
Get file metadata
Returns file metadata including size, hash, and links to XET authentication
GET /containers/{namespace}/{repo}/resolve/{path} - Read
List files
List files
GET /api/containers/{namespace}/{repo}/tree/{path} - Write
Create bucket
Create bucket
POST /api/containers/{namespace}/{repo} - Write
Update bucket settings
Update bucket settings
PUT /api/containers/{namespace}/{repo}/settings - Write
List paths info
List paths info
POST /api/containers/{namespace}/{repo}/paths-info - Destructive
Delete bucket
Delete bucket
DELETE /api/containers/{namespace}/{repo} - Destructive
Delete tag
Deletes a single tag from a container image. The underlying image data is untouched.
DELETE /api/containers/{namespace}/{repo}/tags/{tag} - Destructive
Batch file operations
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":"..."}' ```
POST /api/containers/{namespace}/{repo}/batch
discussions
- Read
List discussions
Get discussions for a repo
GET /api/{repoType}/{namespace}/{repo}/discussions - Read
Get discussion details
Get discussion details
GET /api/{repoType}/{namespace}/{repo}/discussions/{num} - Read
PR storage estimate
Estimates the LFS storage used by a PR that could be freed if the ref is deleted.
GET /api/{repoType}/{namespace}/{repo}/discussions/{num}/storage - Write
Create comment
Create comment
POST /api/blog/{slug}/comment - Write
Create comment
Create comment
POST /api/blog/{slug}/comment/{commentId}/reply - Write
React to comment
React to comment
POST /api/blog/{slug}/comment/{commentId}/reaction - Write
Hide comment
Hide comment
POST /api/blog/{slug}/comment/{commentId}/hide - Write
Update a comment
Update a comment
POST /api/blog/{slug}/comment/{commentId}/edit - Write
Create comment
Create comment
POST /api/blog/{namespace}/{slug}/comment - Write
Create comment
Create comment
POST /api/blog/{namespace}/{slug}/comment/{commentId}/reply - Write
React to comment
React to comment
POST /api/blog/{namespace}/{slug}/comment/{commentId}/reaction - Write
Hide comment
Hide comment
POST /api/blog/{namespace}/{slug}/comment/{commentId}/hide - Write
Update a comment
Update a comment
POST /api/blog/{namespace}/{slug}/comment/{commentId}/edit - Write
Create discussion
Create discussion
POST /api/{repoType}/{namespace}/{repo}/discussions - Write
Create comment
Create comment
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/comment - Write
Change status
Change the status of a discussion
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/status - Write
Change title
Change the title of a discussion
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/title - Write
Pin a discussion
Pin a discussion
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/pin - Write
Merge pull request
Merge pull request
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/merge - Write
Toggle ignore discussion
Toggle ignore discussion
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/ignore - Write
Update a comment
Update a comment
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/comment/{commentId}/edit - Write
Hide comment
Hide comment
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/comment/{commentId}/hide - Write
React to comment
React to comment
POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/comment/{commentId}/reaction - Write
Create comment
Create comment
POST /api/papers/{paperId}/comment - Write
Create comment
Create comment
POST /api/papers/{paperId}/comment/{commentId}/reply - Write
Update a comment
Update a comment
POST /api/papers/{paperId}/comment/{commentId}/edit - Write
Hide comment
Hide comment
POST /api/papers/{paperId}/comment/{commentId}/hide - Write
React to comment
React to comment
POST /api/papers/{paperId}/comment/{commentId}/reaction - Write
Create comment
Create comment
POST /api/posts/{username}/{postSlug}/comment - Write
Create comment
Create comment
POST /api/posts/{username}/{postSlug}/comment/{commentId}/reply - Write
React to comment
React to comment
POST /api/posts/{username}/{postSlug}/comment/{commentId}/reaction - Write
Hide comment
Hide comment
POST /api/posts/{username}/{postSlug}/comment/{commentId}/hide - Write
Update a comment
Update a comment
POST /api/posts/{username}/{postSlug}/comment/{commentId}/edit - Destructive
Delete a discussion
Delete a discussion
DELETE /api/{repoType}/{namespace}/{repo}/discussions/{num} - Destructive
Delete PR ref
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 /api/{repoType}/{namespace}/{repo}/discussions/{num}/ref - Destructive
Delete a discussion
Delete a discussion
DELETE /api/posts/{username}/{postSlug}
blogs
- Read
Blog resource group
Blog resource group
GET /api/blog/{namespace}/{slug}/resource-group - Read
List blogs
List blogs
GET /api/blog/zh - Destructive
Blog resource group
Assign, move, or unassign an organization-owned blog to a resource group. Pass null to unassign. User-owned blogs are not eligible.
POST /api/blog/{namespace}/{slug}/resource-group
docs
- Read
List docs
Get list of available documentation
GET /api/docs - Read
Search docs
Search any Hugging Face documentation
GET /api/docs/search - Read
Full-text search docs
Full-text search across Hugging Face documentation
GET /api/docs/search/full-text
auth
- Read
Get user info
Get information about the user and auth method used
GET /api/whoami-v2
inference-endpoints
- Write
Check access
Check if the user has access to the inference endpoint
POST /api/inference-endpoints/{namespace}/auth-check/{perms} - Write
Check access
Check if the user has access to the inference endpoint
POST /api/inference-endpoints/{namespace}/{endpoint}/auth-check/{perms}
jobs
- Read
Get job hardware
Get available job hardware
GET /api/jobs/hardware - Read
List jobs
List of jobs for an entity
GET /api/jobs/{namespace} - Read
Count jobs
Count the number of jobs for an entity with optional status stage filter
GET /api/jobs/{namespace}/count - Read
Get a job
Get a job
GET /api/jobs/{namespace}/{jobId} - Read
Stream job logs
Stream the logs of a job, using SSE
GET /api/jobs/{namespace}/{jobId}/logs - Read
Stream job metrics
Stream the metrics of a job, using SSE
GET /api/jobs/{namespace}/{jobId}/metrics - Read
Stream job events
Stream the events of a job, using SSE
GET /api/jobs/{namespace}/{jobId}/events - Read
List scheduled jobs
List scheduled jobs for an entity
GET /api/scheduled-jobs/{namespace} - Read
Get scheduled job
Get scheduled job
GET /api/scheduled-jobs/{namespace}/{jobId} - Write
Check access
Check if the user has access to jobs in the namespace
POST /api/jobs/{namespace}/auth-check/{perms} - Write
Check access
Check if the user has access to jobs in the namespace
POST /api/jobs/{namespace}/{jobId}/auth-check/{perms} - Write
Start a job
Start a job
POST /api/jobs/{namespace} - Write
Duplicate a job
Duplicate an existing job, re-using its spec
POST /api/jobs/{namespace}/{jobId}/duplicate - Write
Create scheduled job
Create scheduled job
POST /api/scheduled-jobs/{namespace} - Write
Resume scheduled job
Resume scheduled job
POST /api/scheduled-jobs/{namespace}/{jobId}/resume - Write
Run 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.
POST /api/scheduled-jobs/{namespace}/{jobId}/run - Destructive
Cancel a job
Cancel a job
POST /api/jobs/{namespace}/{jobId}/cancel - Destructive
Update job labels
Replace user-provided labels on a job
PUT /api/jobs/{namespace}/{jobId}/labels - Destructive
Job exposed ports
Replace the exposed ports of a running job, applied live (no re-run). Ports listed in `portsPublic` are reachable without any authentication.
PUT /api/jobs/{namespace}/{jobId}/expose - Destructive
Delete scheduled job
Delete scheduled job
DELETE /api/scheduled-jobs/{namespace}/{jobId} - Destructive
Suspend scheduled job
Suspend scheduled job
POST /api/scheduled-jobs/{namespace}/{jobId}/suspend - Destructive
Update job schedule
Update job schedule
POST /api/scheduled-jobs/{namespace}/{jobId}/schedule - Destructive
Scheduled job labels
Replace user-provided labels on a scheduled job
PUT /api/scheduled-jobs/{namespace}/{jobId}/labels
models
- Read
List likers
List likers
GET /api/models/{namespace}/{repo}/likers - Read
Get folder size
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.
GET /api/models/{namespace}/{repo}/treesize/{rev}/{path} - Read
Get safetensors metadata
Get the parsed headers of all the shards of a sharded safetensors model in a single request, instead of reading the index and then the header of every shard. Only the `main` revision is served: the `ETag` is the commit sha of `main`, and requests with a matching `If-None-Match` get a 304. Returns 400 when the path isn't a `.safetensors.index.json` file and 422 when the files can't be parsed. The response is brotli-compressed when the client accepts it, otherwise gzip-compressed or plain JSON.
GET /api/models/{namespace}/{repo}/safetensors-metadata/{path} - Read
List Large files
List Xet/LFS files for a repo
GET /api/models/{namespace}/{repo}/lfs-files - Read
List commits
List commits
GET /api/models/{namespace}/{repo}/commits/{rev} - Read
List references
List references
GET /api/models/{namespace}/{repo}/refs - Read
Get compare rev
Get compare rev
GET /api/models/{namespace}/{repo}/compare/{compare} - Read
Xet write token
Get a write short-lived access token for XET upload
GET /api/models/{namespace}/{repo}/xet-write-token/{rev} - Read
Xet read token
Get a read short-lived access token for XET
GET /api/models/{namespace}/{repo}/xet-read-token/{rev} - Read
Get resource group
Get resource group
GET /api/models/{namespace}/{repo}/resource-group - Read
List folder content
List the content of a repository tree, with pagination support.
GET /api/models/{namespace}/{repo}/tree/{rev}/{path} - Read
Get notebook URL
Get a jupyter notebook URL for the requested file
GET /api/models/{namespace}/{repo}/notebook/{rev}/{path} - Read
Get security status
Get the security status of a repo
GET /api/models/{namespace}/{repo}/scan - Read
Generate JWT
Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.
GET /api/models/{namespace}/{repo}/jwt - Read
Get model tags
Get all possible tags used for models, grouped by tag type. Optionally restrict to only one tag type
GET /api/models-tags-by-type - Read
Get trending
Get the trending repositories
GET /api/trending - Read
Resolve a file
This endpoint requires to follow redirection
GET /{namespace}/{repo}/resolve/{rev}/{path} - Read
Resolve a file
This endpoint requires to follow redirection
GET /api/resolve-cache/models/{namespace}/{repo}/{rev}/{path} - Read
Export access report
Export a report of all access requests for a gated repository
GET /{namespace}/{repo}/user-access-report - Read
List access requests
List access requests for a gated repository
GET /api/models/{namespace}/{repo}/user-access-request/{status} - Write
Duplicate xet files
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.
POST /api/models/{namespace}/{repo}/lfs-files/duplicate - Write
List paths info
List paths info
POST /api/models/{namespace}/{repo}/paths-info/{rev} - Write
Check upload method
Check if a file should be uploaded through the Large File mechanism or directly.
POST /api/models/{namespace}/{repo}/preupload/{rev} - Write
Create tag
Create tag
POST /api/models/{namespace}/{repo}/tag/{rev} - Write
Squash ref
Squash all commits in the current ref into a single commit with the given message. Action is irreversible.
POST /api/models/{namespace}/{repo}/super-squash/{rev} - Write
Update repo settings
Update the settings of a repo
PUT /api/models/{namespace}/{repo}/settings - Write
Request access
Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information)
POST /{namespace}/{repo}/ask-access - Write
Grant access
Grant access to a user for a gated repository.
POST /api/models/{namespace}/{repo}/user-access-request/grant - Destructive
Delete Large files
Delete Xet/LFS files in batch
POST /api/models/{namespace}/{repo}/lfs-files/batch - Destructive
Delete Large file
Delete a Xet/LFS file
DELETE /api/models/{namespace}/{repo}/lfs-files/{sha} - Destructive
Commit
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)" } ] } ```
POST /api/models/{namespace}/{repo}/commit/{rev} - Destructive
Delete a tag
Delete a tag
DELETE /api/models/{namespace}/{repo}/tag/{rev} - Destructive
Create branch
Create branch
POST /api/models/{namespace}/{repo}/branch/{rev} - Destructive
Delete a branch
Delete a branch
DELETE /api/models/{namespace}/{repo}/branch/{rev} - Destructive
Add resource group
Add the repository to a resource group
POST /api/models/{namespace}/{repo}/resource-group - Destructive
Cancel access request
Cancel the current user's access request to a gated repository
POST /api/models/{namespace}/{repo}/user-access-request/cancel - Destructive
Handle access request
Handle a user's access request to a gated repository
POST /api/models/{namespace}/{repo}/user-access-request/handle - Destructive
Batch access requests
Accept, reject, reset or set back to pending up to 100 access requests for a single gated repository in one call. The same `status` (and optional `rejectionReason` or `resetReason`) is applied to every request in the list.
POST /api/models/{namespace}/{repo}/user-access-request/batch
datasets
- Read
List likers
List likers
GET /api/datasets/{namespace}/{repo}/likers - Read
Get folder size
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.
GET /api/datasets/{namespace}/{repo}/treesize/{rev}/{path} - Read
List Large files
List Xet/LFS files for a repo
GET /api/datasets/{namespace}/{repo}/lfs-files - Read
List commits
List commits
GET /api/datasets/{namespace}/{repo}/commits/{rev} - Read
List references
List references
GET /api/datasets/{namespace}/{repo}/refs - Read
Get compare rev
Get compare rev
GET /api/datasets/{namespace}/{repo}/compare/{compare} - Read
Xet write token
Get a write short-lived access token for XET upload
GET /api/datasets/{namespace}/{repo}/xet-write-token/{rev} - Read
Xet read token
Get a read short-lived access token for XET
GET /api/datasets/{namespace}/{repo}/xet-read-token/{rev} - Read
Get resource group
Get resource group
GET /api/datasets/{namespace}/{repo}/resource-group - Read
List folder content
List the content of a repository tree, with pagination support.
GET /api/datasets/{namespace}/{repo}/tree/{rev}/{path} - Read
Get notebook URL
Get a jupyter notebook URL for the requested file
GET /api/datasets/{namespace}/{repo}/notebook/{rev}/{path} - Read
Get security status
Get the security status of a repo
GET /api/datasets/{namespace}/{repo}/scan - Read
Get dataset leaderboard
Returns the evaluation results ranked by score for a dataset/task
GET /api/datasets/{namespace}/{repo}/leaderboard - Read
Generate JWT
Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.
GET /api/datasets/{namespace}/{repo}/jwt - Read
Get dataset tags
Get all possible tags used for datasets, grouped by tag type. Optionally restrict to only one tag type
GET /api/datasets-tags-by-type - Read
Resolve a file
This endpoint requires to follow redirection
GET /datasets/{namespace}/{repo}/resolve/{rev}/{path} - Read
Resolve a file
This endpoint requires to follow redirection
GET /api/resolve-cache/datasets/{namespace}/{repo}/{rev}/{path} - Read
Export access report
Export a report of all access requests for a gated repository
GET /datasets/{namespace}/{repo}/user-access-report - Read
List access requests
List access requests for a gated repository
GET /api/datasets/{namespace}/{repo}/user-access-request/{status} - Write
Duplicate xet files
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.
POST /api/datasets/{namespace}/{repo}/lfs-files/duplicate - Write
List paths info
List paths info
POST /api/datasets/{namespace}/{repo}/paths-info/{rev} - Write
Check upload method
Check if a file should be uploaded through the Large File mechanism or directly.
POST /api/datasets/{namespace}/{repo}/preupload/{rev} - Write
Create tag
Create tag
POST /api/datasets/{namespace}/{repo}/tag/{rev} - Write
Squash ref
Squash all commits in the current ref into a single commit with the given message. Action is irreversible.
POST /api/datasets/{namespace}/{repo}/super-squash/{rev} - Write
Update repo settings
Update the settings of a repo
PUT /api/datasets/{namespace}/{repo}/settings - Write
Request access
Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information)
POST /datasets/{namespace}/{repo}/ask-access - Write
Grant access
Grant access to a user for a gated repository.
POST /api/datasets/{namespace}/{repo}/user-access-request/grant - Destructive
Delete Large files
Delete Xet/LFS files in batch
POST /api/datasets/{namespace}/{repo}/lfs-files/batch - Destructive
Delete Large file
Delete a Xet/LFS file
DELETE /api/datasets/{namespace}/{repo}/lfs-files/{sha} - Destructive
Commit
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)" } ] } ```
POST /api/datasets/{namespace}/{repo}/commit/{rev} - Destructive
Delete a tag
Delete a tag
DELETE /api/datasets/{namespace}/{repo}/tag/{rev} - Destructive
Create branch
Create branch
POST /api/datasets/{namespace}/{repo}/branch/{rev} - Destructive
Delete a branch
Delete a branch
DELETE /api/datasets/{namespace}/{repo}/branch/{rev} - Destructive
Add resource group
Add the repository to a resource group
POST /api/datasets/{namespace}/{repo}/resource-group - Destructive
Cancel access request
Cancel the current user's access request to a gated repository
POST /api/datasets/{namespace}/{repo}/user-access-request/cancel - Destructive
Handle access request
Handle a user's access request to a gated repository
POST /api/datasets/{namespace}/{repo}/user-access-request/handle - Destructive
Batch access requests
Accept, reject, reset or set back to pending up to 100 access requests for a single gated repository in one call. The same `status` (and optional `rejectionReason` or `resetReason`) is applied to every request in the list.
POST /api/datasets/{namespace}/{repo}/user-access-request/batch
spaces
- Read
List likers
List likers
GET /api/spaces/{namespace}/{repo}/likers - Read
Get folder size
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.
GET /api/spaces/{namespace}/{repo}/treesize/{rev}/{path} - Read
List Large files
List Xet/LFS files for a repo
GET /api/spaces/{namespace}/{repo}/lfs-files - Read
List commits
List commits
GET /api/spaces/{namespace}/{repo}/commits/{rev} - Read
List references
List references
GET /api/spaces/{namespace}/{repo}/refs - Read
Get compare rev
Get compare rev
GET /api/spaces/{namespace}/{repo}/compare/{compare} - Read
Xet write token
Get a write short-lived access token for XET upload
GET /api/spaces/{namespace}/{repo}/xet-write-token/{rev} - Read
Xet read token
Get a read short-lived access token for XET
GET /api/spaces/{namespace}/{repo}/xet-read-token/{rev} - Read
Get resource group
Get resource group
GET /api/spaces/{namespace}/{repo}/resource-group - Read
List folder content
List the content of a repository tree, with pagination support.
GET /api/spaces/{namespace}/{repo}/tree/{rev}/{path} - Read
Get notebook URL
Get a jupyter notebook URL for the requested file
GET /api/spaces/{namespace}/{repo}/notebook/{rev}/{path} - Read
Get security status
Get the security status of a repo
GET /api/spaces/{namespace}/{repo}/scan - Read
Generate JWT
Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption.
GET /api/spaces/{namespace}/{repo}/jwt - Read
List space hardware
Get available space hardware
GET /api/spaces/hardware - Read
List Space templates
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 /api/spaces/templates - Read
Get ZeroGPU quota
Get the authenticated user's current ZeroGPU quota usage and limits
GET /api/spaces/zero-gpu/quota - Read
List secrets
List a Space's secret keys. Values are never returned.
GET /api/spaces/{namespace}/{repo}/secrets - Read
List variables
List a Space's variables with their values.
GET /api/spaces/{namespace}/{repo}/variables - Read
Resolve a file
This endpoint requires to follow redirection
GET /spaces/{namespace}/{repo}/resolve/{rev}/{path} - Read
Resolve a file
This endpoint requires to follow redirection
GET /api/resolve-cache/spaces/{namespace}/{repo}/{rev}/{path} - Read
Stream logs
Get logs for a specific Space in a streaming fashion, with SSE protocol
GET /api/spaces/{namespace}/{repo}/logs/{logType} - Read
Stream events
Get status updates for a specific Space in a streaming fashion, with SSE protocol
GET /api/spaces/{namespace}/{repo}/events - Read
Stream metrics
Get live metrics for a specific Space in a streaming fashion, with SSE protocol, such as current Zero-GPU usage
GET /api/spaces/{namespace}/{repo}/metrics - Read
Semantic search
Semantic search
GET /api/spaces/semantic-search - Read
Featured spaces
Featured spaces
GET /api/spaces/featured - Write
Duplicate xet files
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.
POST /api/spaces/{namespace}/{repo}/lfs-files/duplicate - Write
List paths info
List paths info
POST /api/spaces/{namespace}/{repo}/paths-info/{rev} - Write
Check upload method
Check if a file should be uploaded through the Large File mechanism or directly.
POST /api/spaces/{namespace}/{repo}/preupload/{rev} - Write
Create tag
Create tag
POST /api/spaces/{namespace}/{repo}/tag/{rev} - Write
Squash ref
Squash all commits in the current ref into a single commit with the given message. Action is irreversible.
POST /api/spaces/{namespace}/{repo}/super-squash/{rev} - Write
Update repo settings
Update the settings of a repo
PUT /api/spaces/{namespace}/{repo}/settings - Write
Upsert variable
Upsert Spaces's variable
POST /api/spaces/{namespace}/{repo}/variables - Write
Set Space volumes
Set Space volumes
PUT /api/spaces/{namespace}/{repo}/volumes - Write
Update hardware flavor
Update hardware flavor
POST /api/spaces/{namespace}/{repo}/hardware - Write
Set sleep time
Set sleep time
POST /api/spaces/{namespace}/{repo}/sleeptime - Write
Toggle dev mode
Toggle dev mode
POST /api/spaces/{namespace}/{repo}/dev-mode - Write
Set custom domain
Set custom domain
POST /api/spaces/{namespace}/{repo}/custom-domain - Destructive
Delete Large files
Delete Xet/LFS files in batch
POST /api/spaces/{namespace}/{repo}/lfs-files/batch - Destructive
Delete Large file
Delete a Xet/LFS file
DELETE /api/spaces/{namespace}/{repo}/lfs-files/{sha} - Destructive
Commit
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)" } ] } ```
POST /api/spaces/{namespace}/{repo}/commit/{rev} - Destructive
Delete a tag
Delete a tag
DELETE /api/spaces/{namespace}/{repo}/tag/{rev} - Destructive
Create branch
Create branch
POST /api/spaces/{namespace}/{repo}/branch/{rev} - Destructive
Delete a branch
Delete a branch
DELETE /api/spaces/{namespace}/{repo}/branch/{rev} - Destructive
Add resource group
Add the repository to a resource group
POST /api/spaces/{namespace}/{repo}/resource-group - Destructive
Upsert secret
Upsert Spaces's secret
POST /api/spaces/{namespace}/{repo}/secrets - Destructive
Delete secret
Delete Spaces's secret
DELETE /api/spaces/{namespace}/{repo}/secrets - Destructive
Delete variable
Delete Spaces's variable
DELETE /api/spaces/{namespace}/{repo}/variables - Destructive
Delete Space volumes
Delete Space volumes
DELETE /api/spaces/{namespace}/{repo}/volumes
kernels
- Read
List likers
List likers
GET /api/kernels/{namespace}/{repo}/likers - Read
Get security status
Get the security status of a repo
GET /api/kernels/{namespace}/{repo}/scan - Read
List kernels
List kernels with optional filtering, sorting, and pagination
GET /api/kernels - Read
Get kernel
Get kernel
GET /api/kernels/{namespace}/{repo} - Read
Get kernel
Get kernel
GET /api/kernels/{namespace}/{repo}/revision/{rev} - Write
Duplicate xet files
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.
POST /api/kernels/{namespace}/{repo}/lfs-files/duplicate - Write
Approve kernel access
Approve kernel access
POST /api/kernels/access-request/approve
buckets
- Read
Xet write token
Get a write short-lived access token for XET upload
GET /api/buckets/{namespace}/{repo}/xet-write-token - Read
Xet read token
Get a read short-lived access token for XET
GET /api/buckets/{namespace}/{repo}/xet-read-token - Read
Get resource group
Get resource group
GET /api/buckets/{namespace}/{repo}/resource-group - Read
Get bucket details
Get bucket details
GET /api/buckets/{namespace}/{repo} - Read
List namespace buckets
List namespace buckets
GET /api/buckets/{namespace} - Read
Get file metadata
Returns file metadata including size, hash, and links to XET authentication
GET /buckets/{namespace}/{repo}/resolve/{path} - Read
List files
List files
GET /api/buckets/{namespace}/{repo}/tree/{path} - Read
Follow changes
Server-sent events (`Accept: text/event-stream`) of the bucket's file changes, so clients can stop polling `/tree`. Events: - `ready`: `{"cursor"}` — replay (if any) is done, live changes follow. `cursor` may be absent if the feed has seen no change yet. - `changes`: `{"cursor", "changes": [{"path", "op": "add" | "update" | "delete", "size"?, "xetHash"?, "uploadedAt"?, "mtime"?, "mtimeNanos"?}]}` — a batch of changes coalesced over ~200ms. An `update` only carries the fields that changed (an identical re-upload has just `uploadedAt`); `mtime`/`mtimeNanos` are `null` when a re-upload cleared them. `xetHash` is omitted without content read access. - `reset`: `{"reason": "cursor_too_old"}` — the requested `cursor`/`since` is older than what the server buffers (about 15 minutes); the stream ends and the client must re-list. A `since` at or after the bucket's `updatedAt` never resets, however old. - `reconnect`: `{"cursor"}` — sent after 20 minutes or when the server shuts down (deploys), then the stream ends; reconnect with that cursor. Treat any other end of the stream the same way: reconnect with the last cursor you received. A `: ping` comment is sent every 30s. Resume with `?cursor=` (exclusive) or `?since=` (inclusive); without either, only live changes are sent.
GET /api/buckets/{namespace}/{repo}/events - Write
Duplicate xet files
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.
POST /api/buckets/{namespace}/{repo}/lfs-files/duplicate - Write
Create bucket
Create bucket
POST /api/buckets/{namespace}/{repo} - Write
Update bucket settings
Update bucket settings
PUT /api/buckets/{namespace}/{repo}/settings - Write
List paths info
List paths info
POST /api/buckets/{namespace}/{repo}/paths-info - Destructive
Add resource group
Add the repository to a resource group
POST /api/buckets/{namespace}/{repo}/resource-group - Destructive
Delete bucket
Delete bucket
DELETE /api/buckets/{namespace}/{repo} - Destructive
Batch file operations
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":"..."}' ```
POST /api/buckets/{namespace}/{repo}/batch
agents
- Read
Get agent harnesses
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 /api/agent-harnesses
repo-search
- Read
Quick search
Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets
GET /api/quicksearch - Read
Full-text search
Full-text search
GET /api/search/full-text - Write
Quick search
Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets
POST /api/quicksearch
repos
- Read
Duplication status
Duplication status
GET /api/{repoType}/{namespace}/{repo}/duplicate/status - Write
Duplicate a repository
Duplicate a repository
POST /api/{repoType}/{namespace}/{repo}/duplicate - Write
Create repository
Create repository
POST /api/repos/create - Write
Move repo
Move or rename a repo
POST /api/repos/move
sql-console
- Write
Update embed
Update SQL Console embed
PATCH /api/{repoType}/{namespace}/{repo}/sql-console/embed/{id} - Write
Hide embed
Hide a SQL Console embed from the dataset's community queries. Requires write access to the dataset.
POST /api/{repoType}/{namespace}/{repo}/sql-console/embed/{id}/hide - Write
Create embed
Create SQL Console embed
POST /api/{repoType}/{namespace}/{repo}/sql-console/embed - Destructive
Delete embed
Delete SQL Console embed
DELETE /api/{repoType}/{namespace}/{repo}/sql-console/embed/{id}
collections
- Read
Get a collection
Get a collection
GET /api/collections/{namespace}/{slug}-{id} - Read
Get a collection
Get a collection
GET /api/collections/{namespace}/{slug} - Read
Get collections
Get collections
GET /api/collections - Read
Collection resource group
Collection resource group
GET /api/collections/{namespace}/{slug}-{id}/resource-group - Read
Collection resource group
Collection resource group
GET /api/collections/{namespace}/{slug}/resource-group - Write
Update a collection
Update a collection
PATCH /api/collections/{namespace}/{slug}-{id} - Write
Update a collection
Update a collection
PATCH /api/collections/{namespace}/{slug} - Write
Add item
Add an item to a collection
POST /api/collections/{namespace}/{slug}-{id}/items - Write
Add item
Add an item to a collection
POST /api/collections/{namespace}/{slug}/items - Write
Batch update items
Batch update items in a collection
POST /api/collections/{namespace}/{slug}-{id}/items/batch - Write
Batch update items
Batch update items in a collection
POST /api/collections/{namespace}/{slug}/items/batch - Write
Update item
Update an item in a collection
PATCH /api/collections/{namespace}/{slug}-{id}/items/{itemId} - Write
Update item
Update an item in a collection
PATCH /api/collections/{namespace}/{slug}/items/{slug} - Write
Create a collection
Create a collection
POST /api/collections - Destructive
Delete a collection
Delete a collection
DELETE /api/collections/{namespace}/{slug}-{id} - Destructive
Delete a collection
Delete a collection
DELETE /api/collections/{namespace}/{slug} - Destructive
Delete item
Delete an item from a collection
DELETE /api/collections/{namespace}/{slug}-{id}/items/{itemId} - Destructive
Delete item
Delete an item from a collection
DELETE /api/collections/{namespace}/{slug}/items/{slug} - Destructive
Collection resource group
Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible.
POST /api/collections/{namespace}/{slug}-{id}/resource-group - Destructive
Collection resource group
Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible.
POST /api/collections/{namespace}/{slug}/resource-group
No operations match.
See How connections work for access and permissions, or browse all integrations.