{ "opencollection": "1.0.0", "info": { "name": "Hub API Endpoints", "version": "0.0.1" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "notifications", "type": "folder" }, "items": [ { "info": { "name": "List notifications", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/notifications", "params": [ { "name": "p", "value": "", "type": "query" }, { "name": "readStatus", "value": "", "type": "query" }, { "name": "repoType", "value": "", "type": "query" }, { "name": "repoName", "value": "", "type": "query" }, { "name": "postAuthor", "value": "", "type": "query" }, { "name": "paperId", "value": "", "type": "query" }, { "name": "articleId", "value": "", "type": "query" }, { "name": "mention", "value": "", "type": "query" }, { "name": "lastUpdate", "value": "", "type": "query" } ] }, "docs": "List notifications for the user" }, { "info": { "name": "Delete notifications", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/notifications", "params": [ { "name": "p", "value": "", "type": "query" }, { "name": "readStatus", "value": "", "type": "query" }, { "name": "repoType", "value": "", "type": "query" }, { "name": "repoName", "value": "", "type": "query" }, { "name": "postAuthor", "value": "", "type": "query" }, { "name": "paperId", "value": "", "type": "query" }, { "name": "articleId", "value": "", "type": "query" }, { "name": "mention", "value": "", "type": "query" }, { "name": "lastUpdate", "value": "", "type": "query" }, { "name": "applyToAll", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete notifications, either by specifying discussionIds or by applying to all notifications with search parameters" }, { "info": { "name": "Change read status", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/notifications/mark-as-read", "params": [ { "name": "p", "value": "", "type": "query" }, { "name": "readStatus", "value": "", "type": "query" }, { "name": "repoType", "value": "", "type": "query" }, { "name": "repoName", "value": "", "type": "query" }, { "name": "postAuthor", "value": "", "type": "query" }, { "name": "paperId", "value": "", "type": "query" }, { "name": "articleId", "value": "", "type": "query" }, { "name": "mention", "value": "", "type": "query" }, { "name": "lastUpdate", "value": "", "type": "query" }, { "name": "applyToAll", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update notification settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/settings/notifications", "body": { "type": "json", "data": "{}" } }, "docs": "Update notification settings for the user" }, { "info": { "name": "Update watch settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/settings/watch", "body": { "type": "json", "data": "{}" } }, "docs": "Update watch settings for the user. Get notified when discussions happen on your watched items." } ] }, { "info": { "name": "users", "type": "folder" }, "items": [ { "info": { "name": "Get MCP tools", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/mcp" }, "docs": "Get the MCP tools for the current user" }, { "info": { "name": "List user repositories with storage info", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/repositories", "params": [ { "name": "search", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List user repositories with storage info" }, { "info": { "name": "Get user usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/billing/usage", "params": [ { "name": "periodId", "value": "", "type": "query" } ] }, "docs": "Get user usage for a given period" }, { "info": { "name": "Get user usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/billing/usage-v2", "params": [ { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" } ] }, "docs": "Get user usage for a given period" }, { "info": { "name": "Get jobs usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/billing/usage/jobs" }, "docs": "Get user Jobs usage for current subscription period" }, { "info": { "name": "Stream usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/billing/usage/live" }, "docs": "Get live usage for user" }, { "info": { "name": "Stream usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/users/:username/billing/usage/live", "params": [ { "name": "username", "value": "", "type": "path" } ] }, "docs": "Get live usage for user" }, { "info": { "name": "User overview", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/users/:username/overview", "params": [ { "name": "username", "value": "", "type": "path" } ] }, "docs": "User overview" }, { "info": { "name": "Get social handles", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/users/:username/socials", "params": [ { "name": "username", "value": "", "type": "path" } ] }, "docs": "Get a user's social media handles" }, { "info": { "name": "Retrieve user avatar", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/users/:username/avatar", "params": [ { "name": "username", "value": "", "type": "path" }, { "name": "redirect", "value": "", "type": "query" } ] }, "docs": "This endpoint returns a JSON with the avatar URL for the user.\n\nIf called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL" }, { "info": { "name": "List user likes", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/users/:username/likes", "params": [ { "name": "username", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" } ] }, "docs": "List public repos liked by a user" }, { "info": { "name": "Get avatar", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/avatars/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" } ] }, "docs": "Display the avatar for any user or organization. This endpoint redirects to the avatar URL for either a user or an organization" } ] }, { "info": { "name": "webhooks", "type": "folder" }, "items": [ { "info": { "name": "List webhooks", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/webhooks" }, "docs": "List webhooks" }, { "info": { "name": "Create webhook", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/settings/webhooks", "body": { "type": "json", "data": "{}" } }, "docs": "Create webhook" }, { "info": { "name": "Get webhook", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/settings/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path" } ] }, "docs": "Get webhook" }, { "info": { "name": "Update webhook", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/settings/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update webhook" }, { "info": { "name": "Delete webhook", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/settings/webhooks/:webhookId", "params": [ { "name": "webhookId", "value": "", "type": "path" } ] }, "docs": "Delete webhook" }, { "info": { "name": "Enable/disable webhook", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/settings/webhooks/:webhookId/:action", "params": [ { "name": "webhookId", "value": "", "type": "path" }, { "name": "action", "value": "", "type": "path" } ] }, "docs": "Enable/disable webhook" }, { "info": { "name": "Replay webhook log", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/settings/webhooks/:webhookId/replay/:logId", "params": [ { "name": "webhookId", "value": "", "type": "path" }, { "name": "logId", "value": "", "type": "path" } ] }, "docs": "Replay webhook log" } ] }, { "info": { "name": "papers", "type": "folder" }, "items": [ { "info": { "name": "Claim paper authorship", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/settings/papers/claim", "body": { "type": "json", "data": "{}" } }, "docs": "Claim paper authorship" }, { "info": { "name": "Get Daily Papers", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/daily_papers", "params": [ { "name": "p", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "date", "value": "", "type": "query" }, { "name": "week", "value": "", "type": "query" }, { "name": "month", "value": "", "type": "query" }, { "name": "submitter", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "Get Daily Papers" }, { "info": { "name": "List papers", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/papers", "params": [ { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "List arXiv papers sorted by published date" }, { "info": { "name": "Search papers", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/papers/search", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Perform a hybrid semantic / full-text-search on papers" }, { "info": { "name": "Index a paper", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/papers/index", "body": { "type": "json", "data": "{}" } }, "docs": "Index a paper from arXiv by its ID. If the paper is already indexed, only its authors can re-index it." }, { "info": { "name": "Get a paper", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/papers/:paperId", "params": [ { "name": "paperId", "value": "", "type": "path" }, { "name": "field", "value": "", "type": "query" } ] }, "docs": "Get a paper" }, { "info": { "name": "Update paper links", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/papers/:paperId/links", "params": [ { "name": "paperId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." } ] }, { "info": { "name": "orgs", "type": "folder" }, "items": [ { "info": { "name": "Revoke a member's access token from the organization", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/settings/tokens/revoke", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List organization repositories with storage info", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/settings/repositories", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "direction", "value": "", "type": "query" } ] }, "docs": "List organization repositories with storage info" }, { "info": { "name": "Export the audit log", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/audit-log/export", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query" } ] }, "docs": "Export the audit log events in JSON format for a Team or Enterprise organization. The export is limited to the last 100,000 events." }, { "info": { "name": "Get network security settings", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/settings/network-security", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get the network security settings for an organization." }, { "info": { "name": "Update network security settings", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/organizations/:name/settings/network-security", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update the network security settings for an organization." }, { "info": { "name": "Get avatar", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/avatar", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "redirect", "value": "", "type": "query" } ] }, "docs": "Retrieve organization avatar. This endpoint returns a JSON with the avatar URL for the organization.\n\nIf called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL" }, { "info": { "name": "Get organization members", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/members", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query" }, { "name": "email", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Get a list of members for the organization with optional search and pagination." }, { "info": { "name": "Change member role", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/organizations/:name/members/:username/role", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "username", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the role of a member in the organization. Need a paid plan." }, { "info": { "name": "Get org usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/billing/usage", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "periodId", "value": "", "type": "query" } ] }, "docs": "Get org usage for a given period" }, { "info": { "name": "Get org usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/billing/usage-v2", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" } ] }, "docs": "Get org usage for a given period" }, { "info": { "name": "Get org usage by resource group", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/billing/usage-by-resource-group", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startDate", "value": "", "type": "query" }, { "name": "endDate", "value": "", "type": "query" } ] }, "docs": "Get org usage breakdown per resource group for a given period (max 3 months)" }, { "info": { "name": "Stream usage", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/billing/usage/live", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get live usage for org" }, { "info": { "name": "Get social handles", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/socials", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Get an organization's social media handles" } ] }, { "info": { "name": "resource-groups", "type": "folder" }, "items": [ { "info": { "name": "Get resource groups", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/resource-groups", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Retrieve accessible resource groups. Get all resource groups the user has access to.\n\nRequires the org to be Enterprise" }, { "info": { "name": "Create a resource group", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/resource-groups", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new resource group in the organization.\n\nRequires the org to be Enterprise" } ] }, { "info": { "name": "scim", "type": "folder" }, "items": [ { "info": { "name": "Get SCIM Service Provider Configuration", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/ServiceProviderConfig", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Returns the SCIM 2.0 Service Provider configuration, describing the server's capabilities and supported authentication schemes." }, { "info": { "name": "Get SCIM Resource Types", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/ResourceTypes", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Returns the list of SCIM 2.0 resource types supported by this server (User and Group)." }, { "info": { "name": "Get SCIM Schemas", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Schemas", "params": [ { "name": "name", "value": "", "type": "path" } ] }, "docs": "Returns the SCIM 2.0 schema definitions for User and Group resources." }, { "info": { "name": "Get SCIM Schema by ID", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Schemas/:schemaId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "schemaId", "value": "", "type": "path" } ] }, "docs": "Returns a single SCIM 2.0 schema definition by its schema URI." }, { "info": { "name": "List SCIM users", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startIndex", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a SCIM user", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new user in the organization. If the user already exists, only `active` field will be updated to provision the user." }, { "info": { "name": "Get a SCIM user", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Retrieves a SCIM user by their ID." }, { "info": { "name": "Update a SCIM user", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Update SCIM user", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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.\n If you set `active` to `false`, the user will be deprovisioned from the organization. \nComplicated SCIM `path` values are not supported like `emails[type eq 'work'].value`." }, { "info": { "name": "Delete a SCIM user", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Delete a SCIM user" }, { "info": { "name": "List SCIM groups", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startIndex", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "excludedAttributes", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a SCIM group", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new group in the organization. The group name must be unique within the organization." }, { "info": { "name": "Get a SCIM group", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" }, { "name": "excludedAttributes", "value": "", "type": "query" } ] }, "docs": "Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned." }, { "info": { "name": "Update a SCIM group", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a group by its ID. The group name must be unique within the organization." }, { "info": { "name": "Update SCIM group", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a SCIM group", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/organizations/:name/scim/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Delete a SCIM group" }, { "info": { "name": "List SCIM-managed users", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startIndex", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" } ] }, "docs": "Retrieves a paginated list of organization members and pending invitations managed by SCIM for non-managed organizations." }, { "info": { "name": "Create a SCIM provisioning user invitation", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates an invitation for a user to join the organization. The user must have an existing Hugging Face account." }, { "info": { "name": "Get a SCIM provisioning user", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Retrieves a SCIM user by their ID for non-managed organizations." }, { "info": { "name": "Update a SCIM provisioning user", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a provisioned user's invitation for non-managed organizations. User profile fields are not editable via SCIM for non-managed organizations." }, { "info": { "name": "Update an attribute of a SCIM provisioning user", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Modify individual attributes for non-managed organizations. Only the `active` field can be modified. User profile fields are not editable via SCIM." }, { "info": { "name": "Delete a SCIM provisioning user", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Users/:userId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ] }, "docs": "Removes a user from the organization and deletes any pending invitations for non-managed organizations." }, { "info": { "name": "List SCIM groups", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "startIndex", "value": "", "type": "query" }, { "name": "count", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "excludedAttributes", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a SCIM group", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups", "params": [ { "name": "name", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new group in the organization. The group name must be unique within the organization." }, { "info": { "name": "Get a SCIM group", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" }, { "name": "excludedAttributes", "value": "", "type": "query" } ] }, "docs": "Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned." }, { "info": { "name": "Update a SCIM group", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a group by its ID. The group name must be unique within the organization." }, { "info": { "name": "Update SCIM group", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete a SCIM group", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/organizations/:name/scim-provisioning/v2/Groups/:groupId", "params": [ { "name": "name", "value": "", "type": "path" }, { "name": "groupId", "value": "", "type": "path" } ] }, "docs": "Delete a SCIM group" } ] }, { "info": { "name": "agentic-provisioning", "type": "folder" }, "items": [ { "info": { "name": "Get Agentic Provisioning health", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/agentic/provisioning/health" }, "docs": "Get Agentic Provisioning health" }, { "info": { "name": "Get Agentic Provisioning services", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/agentic/provisioning/services" }, "docs": "Get Agentic Provisioning services" }, { "info": { "name": "Create an Agentic Provisioning account request", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/account_requests", "body": { "type": "json", "data": "{}" } }, "docs": "Create an Agentic Provisioning account request" }, { "info": { "name": "Provision a resource", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/resources", "body": { "type": "json", "data": "{}" } }, "docs": "Provision a resource" }, { "info": { "name": "Get a resource by ID", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/agentic/provisioning/resources/:id", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a resource by ID" }, { "info": { "name": "Update a resource's service (e.g. plan upgrade)", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/resources/:id/update_service", "params": [ { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a resource's service (e.g. plan upgrade)" }, { "info": { "name": "Remove / de-provision a resource", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/resources/:id/remove", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Remove / de-provision a resource" }, { "info": { "name": "Rotate the credentials for a resource", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/resources/:id/rotate_credentials", "params": [ { "name": "id", "value": "", "type": "path" } ] }, "docs": "Rotate the credentials for a resource" }, { "info": { "name": "Create a self-authenticated deep link to the user's billing dashboard", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/agentic/provisioning/deep_links", "body": { "type": "json", "data": "{}" } }, "docs": "Create a self-authenticated deep link to the user's billing dashboard" } ] }, { "info": { "name": "oauth", "type": "folder" }, "items": [ { "info": { "name": "Register a new OAuth app", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/oauth/register", "body": { "type": "json", "data": "{}" } }, "docs": "Register a new OAuth app" }, { "info": { "name": "Initiate device authorization", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/oauth/device", "body": { "type": "json", "data": "{}" } }, "docs": "Initiate device authorization" }, { "info": { "name": "Get user info", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/oauth/userinfo" }, "docs": "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." }, { "info": { "name": "Get user info", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/oauth/userinfo" }, "docs": "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." } ] }, { "info": { "name": "discussions", "type": "folder" }, "items": [ { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/blog/:slug/comment", "params": [ { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/blog/:slug/comment/:commentId/reply", "params": [ { "name": "slug", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/blog/:namespace/:slug/comment", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/blog/:namespace/:slug/comment/:commentId/reply", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "List discussions", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "p", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "author", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "Get discussions for a repo" }, { "info": { "name": "Create a new discussion", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new discussion" }, { "info": { "name": "Get discussion details", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ] }, "docs": "Get discussion details" }, { "info": { "name": "Delete a discussion", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ] }, "docs": "Delete a discussion" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/comment", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Change status", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/status", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the status of a discussion" }, { "info": { "name": "Change title", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/title", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Change the title of a discussion" }, { "info": { "name": "Pin a discussion", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/pin", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Pin a discussion" }, { "info": { "name": "Merge a pull request", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/merge", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Merge a pull request" }, { "info": { "name": "Delete PR ref", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/ref", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "PR storage estimate", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/discussions/:num/storage", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "num", "value": "", "type": "path" } ] }, "docs": "Estimates the LFS storage used by a PR that could be freed if the ref is deleted." }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/papers/:paperId/comment", "params": [ { "name": "paperId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/papers/:paperId/comment/:commentId/reply", "params": [ { "name": "paperId", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Delete a discussion", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/posts/:username/:postSlug", "params": [ { "name": "username", "value": "", "type": "path" }, { "name": "postSlug", "value": "", "type": "path" } ] }, "docs": "Delete a discussion" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/posts/:username/:postSlug/comment", "params": [ { "name": "username", "value": "", "type": "path" }, { "name": "postSlug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" }, { "info": { "name": "Create a new comment", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/posts/:username/:postSlug/comment/:commentId/reply", "params": [ { "name": "username", "value": "", "type": "path" }, { "name": "postSlug", "value": "", "type": "path" }, { "name": "commentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new comment" } ] }, { "info": { "name": "docs", "type": "folder" }, "items": [ { "info": { "name": "List docs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/docs" }, "docs": "Get list of available documentation" }, { "info": { "name": "Search docs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/docs/search", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "product", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Search any Hugging Face documentation" }, { "info": { "name": "Full-text search docs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/docs/search/full-text", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "domain", "value": "", "type": "query" } ] }, "docs": "Full-text search across Hugging Face documentation" } ] }, { "info": { "name": "auth", "type": "folder" }, "items": [ { "info": { "name": "Get user info", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/whoami-v2" }, "docs": "Get information about the user and auth method used" } ] }, { "info": { "name": "inference-endpoints", "type": "folder" }, "items": [ { "info": { "name": "Check access", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/inference-endpoints/:namespace/auth-check/:perms", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "perms", "value": "", "type": "path" }, { "name": "own", "value": "", "type": "query" }, { "name": "is_creator", "value": "", "type": "query" }, { "name": "creator_id", "value": "", "type": "query" }, { "name": "incur_cost", "value": "", "type": "query" }, { "name": "resource_group_id", "value": "", "type": "query" }, { "name": "repo_id", "value": "", "type": "query" } ] }, "docs": "Check if the user has access to the inference endpoint" }, { "info": { "name": "Check access", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/inference-endpoints/:namespace/:endpoint/auth-check/:perms", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "endpoint", "value": "", "type": "path" }, { "name": "perms", "value": "", "type": "path" }, { "name": "own", "value": "", "type": "query" }, { "name": "is_creator", "value": "", "type": "query" }, { "name": "creator_id", "value": "", "type": "query" }, { "name": "incur_cost", "value": "", "type": "query" }, { "name": "resource_group_id", "value": "", "type": "query" }, { "name": "repo_id", "value": "", "type": "query" } ] }, "docs": "Check if the user has access to the inference endpoint" } ] }, { "info": { "name": "models", "type": "folder" }, "items": [ { "info": { "name": "Get folder size", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/: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/models/:namespace/:repo/scan", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get the security status of a repo" }, { "info": { "name": "Generate JWT", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/models/: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 model tags", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/models-tags-by-type", "params": [ { "name": "type", "value": "", "type": "query" } ] }, "docs": "Get all possible tags used for models, 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/: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/models/: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/: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/: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/models/: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/models/: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/models/: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/models/: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/models/: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" } ] }, { "info": { "name": "spaces", "type": "folder" }, "items": [ { "info": { "name": "Get folder size", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/: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/spaces/:namespace/:repo/scan", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get the security status of a repo" }, { "info": { "name": "Generate JWT", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/: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": "List space hardware", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/hardware" }, "docs": "Get available space hardware" }, { "info": { "name": "List secrets", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/:namespace/:repo/secrets", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "List a Space's secret keys. Values are never returned." }, { "info": { "name": "Upsert secret", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/spaces/:namespace/:repo/secrets", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert Spaces's secret" }, { "info": { "name": "Delete secret", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/spaces/:namespace/:repo/secrets", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Spaces's secret" }, { "info": { "name": "List variables", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/:namespace/:repo/variables", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "List a Space's variables with their values." }, { "info": { "name": "Upsert variable", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/spaces/:namespace/:repo/variables", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Upsert Spaces's variable" }, { "info": { "name": "Delete variable", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/spaces/:namespace/:repo/variables", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Delete Spaces's variable" }, { "info": { "name": "Resolve a file", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/spaces/: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/spaces/: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": "Set Space volumes", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/spaces/:namespace/:repo/volumes", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set Space volumes" }, { "info": { "name": "Delete Space volumes", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/spaces/:namespace/:repo/volumes", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Delete Space volumes" }, { "info": { "name": "Stream logs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/:namespace/:repo/logs/:logType", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "logType", "value": "", "type": "path" }, { "name": "tail", "value": "", "type": "query" } ] }, "docs": "Get logs for a specific Space in a streaming fashion, with SSE protocol" }, { "info": { "name": "Stream events", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/:namespace/:repo/events", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "session_uuid", "value": "", "type": "query" } ] }, "docs": "Get status updates for a specific Space in a streaming fashion, with SSE protocol" }, { "info": { "name": "Stream metrics", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/spaces/:namespace/:repo/metrics", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get live metrics for a specific Space in a streaming fashion, with SSE protocol, such as current Zero-GPU usage" } ] }, { "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": "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" } ] }, { "info": { "name": "kernels", "type": "folder" }, "items": [ { "info": { "name": "Duplicate xet files", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/kernels/: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": "Get kernel", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/kernels/:namespace/:repo", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get kernel" }, { "info": { "name": "Get kernel", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/kernels/:namespace/:repo/revision/:rev", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "rev", "value": "", "type": "path" } ] }, "docs": "Get kernel" } ] }, { "info": { "name": "buckets", "type": "folder" }, "items": [ { "info": { "name": "Duplicate xet files", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/buckets/: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": "Xet write token", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/buckets/:namespace/:repo/xet-write-token", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "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/buckets/:namespace/:repo/xet-read-token", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get a read short-lived access token for XET" }, { "info": { "name": "Get resource group", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/buckets/: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/buckets/: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": "Get bucket details", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/buckets/:namespace/:repo", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Get bucket details" }, { "info": { "name": "Create bucket", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/buckets/:namespace/:repo", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create bucket" }, { "info": { "name": "Delete bucket", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/buckets/:namespace/:repo", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Delete bucket" }, { "info": { "name": "Update bucket settings", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/buckets/:namespace/:repo/settings", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update bucket settings" }, { "info": { "name": "List namespace buckets", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/buckets/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "List namespace buckets" }, { "info": { "name": "Retrieve information about a file in a bucket", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/buckets/:namespace/:repo/resolve/:path", "headers": [ { "name": "Accept", "value": "" } ], "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "noContentDisposition", "value": "", "type": "query" }, { "name": "download", "value": "", "type": "query" } ] }, "docs": "Returns file metadata including size, hash, and links to XET authentication" }, { "info": { "name": "Batch file operations", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/buckets/:namespace/:repo/batch", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ] }, "docs": "Accepts NDJSON (newline-delimited JSON) where each line is an addFile, copyFile, or deleteFile instruction.\nAll add/copy operations must come before all delete operations.\n\nJSON-lines payload:\n```json\n\t'{\"type\":\"addFile\",\"path\":\"...\",\"xetHash\":\"...\",\"mtime\":...,\"contentType\":\"...\"}' +\n\t'{\"type\":\"copyFile\",\"path\":\"...\",\"xetHash\":\"...\",\"sourceRepoType\":\"...\",\"sourceRepoId\":\"...\"}' +\n\t'{\"type\":\"deleteFile\",\"path\":\"...\"}'\n```" }, { "info": { "name": "List files", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/buckets/:namespace/:repo/tree/:path", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "path", "value": "", "type": "path" }, { "name": "limit", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "recursive", "value": "", "type": "query" } ] }, "docs": "List files" }, { "info": { "name": "List paths info", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/buckets/:namespace/:repo/paths-info", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "List paths info" } ] }, { "info": { "name": "repo-search", "type": "folder" }, "items": [ { "info": { "name": "Quick search", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/quicksearch", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "library", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "orgsFilter", "value": "", "type": "query" }, { "name": "reposFilter", "value": "", "type": "query" }, { "name": "pipelines", "value": "", "type": "query" }, { "name": "exclude", "value": "", "type": "query" }, { "name": "namespace", "value": "", "type": "query" }, { "name": "includeInvitees", "value": "", "type": "query" }, { "name": "repoName", "value": "", "type": "query" }, { "name": "repoType", "value": "", "type": "query" }, { "name": "discussionId", "value": "", "type": "query" }, { "name": "discussionCollectionName", "value": "", "type": "query" }, { "name": "spacesTags", "value": "", "type": "query" } ] }, "docs": "Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets" }, { "info": { "name": "Quick search", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/quicksearch", "params": [ { "name": "q", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" }, { "name": "lang", "value": "", "type": "query" }, { "name": "library", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "orgsFilter", "value": "", "type": "query" }, { "name": "reposFilter", "value": "", "type": "query" }, { "name": "pipelines", "value": "", "type": "query" }, { "name": "exclude", "value": "", "type": "query" }, { "name": "namespace", "value": "", "type": "query" }, { "name": "includeInvitees", "value": "", "type": "query" }, { "name": "repoName", "value": "", "type": "query" }, { "name": "repoType", "value": "", "type": "query" }, { "name": "discussionId", "value": "", "type": "query" }, { "name": "discussionCollectionName", "value": "", "type": "query" }, { "name": "spacesTags", "value": "", "type": "query" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets" } ] }, { "info": { "name": "repos", "type": "folder" }, "items": [ { "info": { "name": "Duplicate a repository", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/duplicate", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Duplicate a repository" }, { "info": { "name": "Create a new repository", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/repos/create", "body": { "type": "json", "data": "{}" } }, "docs": "Create a new repository" }, { "info": { "name": "Move repo", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/repos/move", "body": { "type": "json", "data": "{}" } }, "docs": "Move or rename a repo" } ] }, { "info": { "name": "sql-console", "type": "folder" }, "items": [ { "info": { "name": "Update embed", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/sql-console/embed/:id", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update SQL Console embed" }, { "info": { "name": "Delete embed", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/sql-console/embed/:id", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete SQL Console embed" }, { "info": { "name": "Create embed", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/:repoType/:namespace/:repo/sql-console/embed", "params": [ { "name": "repoType", "value": "", "type": "path" }, { "name": "namespace", "value": "", "type": "path" }, { "name": "repo", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create SQL Console embed" } ] }, { "info": { "name": "collections", "type": "folder" }, "items": [ { "info": { "name": "Get a collection", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Get a collection" }, { "info": { "name": "Update a collection", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a collection" }, { "info": { "name": "Delete a collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Delete a collection" }, { "info": { "name": "Get a collection", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/collections/:namespace/:slug", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ] }, "docs": "Get a collection" }, { "info": { "name": "Update a collection", "type": "http" }, "http": { "method": "PATCH", "url": "https://huggingface.co/api/collections/:namespace/:slug", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a collection" }, { "info": { "name": "Delete a collection", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/collections/:namespace/:slug", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ] }, "docs": "Delete a collection" }, { "info": { "name": "Add item", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id/items", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an item to a collection" }, { "info": { "name": "Add item", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/collections/:namespace/:slug/items", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Add an item to a collection" }, { "info": { "name": "Batch update items", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id/items/batch", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Batch update items in a collection" }, { "info": { "name": "Batch update items", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/collections/:namespace/:slug/items/batch", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Batch update items in a collection" }, { "info": { "name": "Delete item", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/collections/:namespace/:slug-:id/items/:itemId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" }, { "name": "itemId", "value": "", "type": "path" } ] }, "docs": "Delete an item from a collection" }, { "info": { "name": "Delete item", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/collections/:namespace/:slug/items/:slug", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "slug", "value": "", "type": "path" } ] }, "docs": "Delete an item from a collection" }, { "info": { "name": "Get collections", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/collections", "params": [ { "name": "item", "value": "", "type": "query" }, { "name": "owner", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" }, { "name": "cursor", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" }, { "name": "limit", "value": "", "type": "query" } ] }, "docs": "Get collections" }, { "info": { "name": "Create a collection", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/collections", "body": { "type": "json", "data": "{}" } }, "docs": "Create a collection" } ] }, { "info": { "name": "jobs", "type": "folder" }, "items": [ { "info": { "name": "Get job hardware", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/hardware" }, "docs": "Get available job hardware" }, { "info": { "name": "List jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "label", "value": "", "type": "query" } ] }, "docs": "List of jobs for an entity" }, { "info": { "name": "Start a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Start a job" }, { "info": { "name": "Count jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/count", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "stage", "value": "", "type": "query" } ] }, "docs": "Count the number of jobs for an entity with optional status stage filter" }, { "info": { "name": "Get a job", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Get a job" }, { "info": { "name": "Stream job logs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/logs", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" }, { "name": "tail", "value": "", "type": "query" } ] }, "docs": "Stream the logs of a job, using SSE" }, { "info": { "name": "Stream job metrics", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/metrics", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Stream the metrics of a job, using SSE" }, { "info": { "name": "Stream job events", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/events", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Stream the events of a job, using SSE" }, { "info": { "name": "Cancel a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/cancel", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Cancel a job" }, { "info": { "name": "Duplicate a job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/duplicate", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Duplicate an existing job, re-using its spec" }, { "info": { "name": "Update job labels", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/jobs/:namespace/:jobId/labels", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace user-provided labels on a job" }, { "info": { "name": "List scheduled jobs", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/scheduled-jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "label", "value": "", "type": "query" } ] }, "docs": "List scheduled jobs for an entity" }, { "info": { "name": "Create a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace", "params": [ { "name": "namespace", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a scheduled job" }, { "info": { "name": "Get a scheduled job", "type": "http" }, "http": { "method": "GET", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Get a scheduled job" }, { "info": { "name": "Delete a scheduled job", "type": "http" }, "http": { "method": "DELETE", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Delete a scheduled job" }, { "info": { "name": "Suspend a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/suspend", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Suspend a scheduled job" }, { "info": { "name": "Resume a scheduled job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/resume", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "Resume a scheduled job" }, { "info": { "name": "Run job", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/run", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update a scheduled job schedule", "type": "http" }, "http": { "method": "POST", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/schedule", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update a scheduled job schedule" }, { "info": { "name": "Update scheduled job labels", "type": "http" }, "http": { "method": "PUT", "url": "https://huggingface.co/api/scheduled-jobs/:namespace/:jobId/labels", "params": [ { "name": "namespace", "value": "", "type": "path" }, { "name": "jobId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Replace user-provided labels on a scheduled job" } ] } ], "bundled": true }