{"openapi":"3.0.0","info":{"description":"Hugging Face Hub API - models, datasets and Spaces repositories, user info, settings, webhooks and notifications. Includes Inference Providers: OpenAI-compatible chat completions and model listing via router.huggingface.co","version":[{"name":"v2","value":"v2"}]},"servers":[{"description":"Hugging Face Hub API - models, datasets and Spaces repositories, user info, settings, webhooks and notifications. Includes Inference Providers: OpenAI-compatible chat completions and model listing via router.huggingface.co","url":"https://api.apirails.com/huggingface"}],"paths":{"/api/agent-harnesses":{"get":{"tags":["Agents"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agent-harnesses"},"summary":"Get agent harnesses","description":"Get the registry of AI agents / harnesses known to the Hub, along with the standard environment variables used to detect them. Clients use this registry to identify which agent they are running in when reporting Hub activity. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/agentic/provisioning/account_requests":{"post":{"tags":["Agentic Provisioning"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/account_requests"},"summary":"Create account request","description":"Create account request Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_capabilities":{"type":"array","description":"client capabilities","required":true,"items":{"type":"string"}},"configuration":{"type":"object","description":"configuration","properties":{}},"confirmation_secret":{"type":"string","description":"confirmation secret","required":true},"country":{"type":"string","description":"country"},"email":{"type":"string","description":"email","required":true},"expires_at":{"type":"string","description":"expires at (ISO 8601 date-time format)","required":true},"id":{"type":"string","description":"id","required":true},"kyc":{"type":"object","description":"kyc","properties":{"verified_fields":{"type":"array","description":"verified fields","required":true}}},"name":{"type":"string","description":"name"},"object":{"type":"string","description":"object","required":true,"enum":["account_request"]},"orchestrator":{"type":"object","description":"orchestrator","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["stripe"]},"stripe":{"type":"object","description":"stripe","required":true}}},"phone":{"type":"string","description":"phone"},"scopes":{"type":"array","description":"scopes","required":true,"items":{"type":"string"}}}},"example":{"client_capabilities":[],"configuration":{},"confirmation_secret":"","country":"","email":"","expires_at":"","id":"","kyc":{},"name":"","object":"","orchestrator":{},"phone":"","scopes":[]}}}}}},"/api/agentic/provisioning/deep_links":{"post":{"tags":["Agentic Provisioning"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/deep_links"},"summary":"Create deep link","description":"Create deep link Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"purpose":{"type":"string","description":"purpose","required":true,"enum":["dashboard"]}}},"example":{"purpose":""}}}}}},"/api/agentic/provisioning/health":{"get":{"tags":["Agentic Provisioning"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/health"},"summary":"Get health","description":"Get health Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/agentic/provisioning/resources":{"post":{"tags":["Agentic Provisioning"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/resources"},"summary":"Provision a resource","description":"Provision a resource Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Request body","properties":{}}}},"example":{"body":{}}}}}}},"/api/agentic/provisioning/resources/{id}":{"get":{"tags":["Agentic Provisioning"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/resources/{id}"},"summary":"Get a resource by ID","description":"Get a resource by ID Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/agentic/provisioning/resources/{id}/remove":{"post":{"tags":["Agentic Provisioning"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/resources/{id}/remove"},"summary":"Remove resource","description":"Remove resource Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/agentic/provisioning/resources/{id}/rotate_credentials":{"post":{"tags":["Agentic Provisioning"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/resources/{id}/rotate_credentials"},"summary":"Rotate resource credentials","description":"Rotate resource credentials Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/agentic/provisioning/resources/{id}/update_service":{"post":{"tags":["Agentic Provisioning"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/resources/{id}/update_service"},"summary":"Update resource service","description":"Update resource service Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"configuration":{"type":"object","description":"configuration","properties":{"rechargeAmountUsd":{"type":"object","description":"Set a number (USD, minimum $15) to enable or update pay-as-you-go auto top-up; pass null to disable; omit to leave it unchanged."}}},"payment_credentials":{"type":"object","description":"payment credentials","properties":{"type":{"type":"string","description":"type","required":true,"enum":["stripe_payment_token"]},"stripe_payment_token":{"type":"string","description":"stripe payment token"}}},"service_id":{"type":"string","description":"service id"}}},"example":{"configuration":{},"payment_credentials":{},"service_id":""}}}}}},"/api/agentic/provisioning/services":{"get":{"tags":["Agentic Provisioning"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/agentic/provisioning/services"},"summary":"Get services","description":"Get services Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/avatars/{namespace}":{"get":{"tags":["Users"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/avatars/{namespace}"},"summary":"Get avatar","description":"Display the avatar for any user or organization. This endpoint redirects to the avatar URL for either a user or an organization Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/blog/{namespace}/{slug}/comment":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/blog/{namespace}/{slug}/comment"},"summary":"Create a new comment","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/blog/{namespace}/{slug}/comment/{commentId}/reply":{"post":{"tags":["Discussions"],"parameters":[{"name":"commentId","in":"path","description":"comment Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/blog/{namespace}/{slug}/comment/{commentId}/reply"},"summary":"Create a new comment (Discussions POST)","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/blog/{slug}/comment":{"post":{"tags":["Discussions"],"parameters":[{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/blog/{slug}/comment"},"summary":"Create a new comment (Discussions POST) — POST /api/blog/{slug}/comment","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/blog/{slug}/comment/{commentId}/reply":{"post":{"tags":["Discussions"],"parameters":[{"name":"commentId","in":"path","description":"comment Id","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/blog/{slug}/comment/{commentId}/reply"},"summary":"Create a new comment (Discussions POST) — POST /api/blog/{slug}/comment/{commentId}/reply","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/buckets/{namespace}":{"get":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}"},"summary":"List namespace buckets","description":"List namespace buckets Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/buckets/{namespace}/{repo}":{"delete":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}"},"summary":"Delete bucket","description":"Delete bucket Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}"},"summary":"Get bucket details","description":"Get bucket details Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}"},"summary":"Create bucket","description":"Create bucket Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cdn":{"type":"array","description":"CDN pre-warming regions","items":{"type":"object","properties":{"provider":{"type":"string","description":"provider","required":true,"enum":["gcp","aws"]},"region":{"type":"string","description":"region","required":true,"enum":["us","eu"]}}}},"private":{"type":"object","description":"Bucket visibility. Defaults to public","properties":{}},"region":{"type":"string","description":"The region where the bucket is hosted.","enum":["us","eu"]},"resourceGroupId":{"type":"string","description":"resource Group Id"}}},"example":{"cdn":[],"private":{},"region":"","resourceGroupId":""}}}}}},"/api/buckets/{namespace}/{repo}/batch":{"post":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/batch"},"summary":"Batch file operations","description":"Accepts NDJSON (newline-delimited JSON) where each line is an addFile, copyFile, or deleteFile instruction. All add/copy operations must come before all delete operations. JSON-lines payload: ```json '{\"type\":\"addFile\",\"path\":\"...\",\"xetHash\":\"...\",\"mtime\":...,\"mtimeNanos\":...,\"contentType\":\"...\"}' + '{\"type\":\"copyFile\",\"path\":\"...\",\"xetHash\":\"...\",\"sourceRepoType\":\"...\",\"sourceRepoId\":\"...\",\"mtime\":...,\"mtimeNanos\":...,\"contentType\":\"...\"}' + '{\"type\":\"deleteFile\",\"path\":\"...\"}' ``` Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/buckets/{namespace}/{repo}/lfs-files/duplicate":{"post":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/lfs-files/duplicate"},"summary":"Duplicate xet files","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"filename":{"type":"string","description":"filename"},"sha256":{"type":"string","description":"sha256","required":true},"xetHash":{"type":"string","description":"xet Hash","required":true}}}},"target":{"type":"object","description":"target","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","kernel"]},"name":{"type":"string","description":"name","required":true}}}}},"example":{"files":[],"target":{}}}}}}},"/api/buckets/{namespace}/{repo}/paths-info":{"post":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/paths-info"},"summary":"List paths info","description":"List paths info Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"paths":{"type":"object","description":"paths","required":true,"properties":{}}}},"example":{"paths":{}}}}}}},"/api/buckets/{namespace}/{repo}/resource-group":{"get":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/resource-group"},"summary":"Get resource group","description":"Get resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/resource-group"},"summary":"Add resource group","description":"Add the repository to a resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to add the repository to, if null, the repository will be removed from the resource group","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/buckets/{namespace}/{repo}/settings":{"put":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/settings"},"summary":"Update bucket settings","description":"Update bucket settings Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cdnRegions":{"type":"array","description":"cdn Regions","required":true,"items":{"type":"object","properties":{"provider":{"type":"string","description":"provider","required":true,"enum":["gcp","aws"]},"region":{"type":"string","description":"region","required":true,"enum":["us","eu"]}}}},"private":{"type":"object","description":"private","properties":{}}}},"example":{"cdnRegions":[],"private":{}}}}}}},"/api/buckets/{namespace}/{repo}/tree/{path}":{"get":{"tags":["Buckets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Pagination cursor","required":false,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"Sort direction. Defaults to `asc` for `path` and `desc` for `uploadedAt`.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"recursive","in":"query","description":"When false, returns collapsed directory entries instead of listing all files recursively. The number of entries returned can then be less than the limit, but there will always be a pagination link if there are more entries. Note: non-recursive listing hasn't a strong consistency guarantees.","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sort order. `path` (default) sorts lexicographically; `uploadedAt` sorts by most recent upload first. In recursive mode `uploadedAt` is only supported at the bucket root (no path prefix). In non-recursive mode, only supported at root or exact folder prefixes.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["path","uploadedAt"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/tree/{path}"},"summary":"List files","description":"List files Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/buckets/{namespace}/{repo}/xet-read-token":{"get":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/xet-read-token"},"summary":"Xet read token","description":"Get a read short-lived access token for XET Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/buckets/{namespace}/{repo}/xet-write-token":{"get":{"tags":["Buckets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/buckets/{namespace}/{repo}/xet-write-token"},"summary":"Xet write token","description":"Get a write short-lived access token for XET upload Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/collections":{"get":{"tags":["Collections"],"parameters":[{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"expand","required":false,"schema":{"type":"string","example":""}},{"name":"item","in":"query","description":"item","required":false,"schema":{"type":"object","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"owner","in":"query","description":"owner","required":false,"schema":{"type":"object","example":""}},{"name":"q","in":"query","description":"q","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["upvotes","lastModified","trending"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections"},"summary":"Get collections","description":"Get collections Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Collections"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections"},"summary":"Create a collection","description":"Create a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"item":{"type":"object","description":"item","properties":{"type":{"type":"string","description":"type","required":true,"enum":["paper","collection","space","model","dataset","bucket"]},"id":{"type":"string","description":"id","required":true}}},"namespace":{"type":"string","description":"namespace","required":true},"private":{"type":"boolean","description":"If not provided, the collection will be public. This field will respect the organization's visibility setting.","enum":[true,false]},"resourceGroupId":{"type":"string","description":"Assign the collection to a resource group of the owning organization. Only valid for organization-owned collections."},"title":{"type":"string","description":"title","required":true}}},"example":{"description":"","item":{},"namespace":"","private":"","resourceGroupId":"","title":""}}}}}},"/api/collections/{namespace}/{slug}":{"delete":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}"},"summary":"Delete a collection","description":"Delete a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}"},"summary":"Get a collection","description":"Get a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}"},"summary":"Update a collection","description":"Update a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"gating":{"type":"object","description":"gating","properties":{"mode":{"type":"string","description":"mode","required":true,"enum":["auto","manual"]},"notifications":{"type":"object","description":"notifications","required":true}}},"position":{"type":"number","description":"position"},"private":{"type":"boolean","description":"private","enum":[true,false]},"theme":{"type":"string","description":"theme","enum":["orange","blue","green","purple","pink","indigo"]},"title":{"type":"string","description":"title"}}},"example":{"description":"","gating":{},"position":"","private":"","theme":"","title":""}}}}}},"/api/collections/{namespace}/{slug}-{id}":{"delete":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}"},"summary":"Delete a collection (Collections DELETE)","description":"Delete a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}"},"summary":"Get a collection (Collections GET)","description":"Get a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}"},"summary":"Update a collection (Collections PATCH)","description":"Update a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"gating":{"type":"object","description":"gating","properties":{"mode":{"type":"string","description":"mode","required":true,"enum":["auto","manual"]},"notifications":{"type":"object","description":"notifications","required":true}}},"position":{"type":"number","description":"position"},"private":{"type":"boolean","description":"private","enum":[true,false]},"theme":{"type":"string","description":"theme","enum":["orange","blue","green","purple","pink","indigo"]},"title":{"type":"string","description":"title"}}},"example":{"description":"","gating":{},"position":"","private":"","theme":"","title":""}}}}}},"/api/collections/{namespace}/{slug}-{id}/items":{"post":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/items"},"summary":"Add item","description":"Add an item to a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"item":{"type":"object","description":"item","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["paper","collection","space","model","dataset","bucket"]},"id":{"type":"string","description":"id","required":true}}},"note":{"type":"string","description":"note"}}},"example":{"item":{},"note":""}}}}}},"/api/collections/{namespace}/{slug}-{id}/items/batch":{"post":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/items/batch"},"summary":"Batch update items","description":"Batch update items in a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"items":{"type":"array","description":"The request body array. Send the bare JSON array itself as the request body, not wrapped in an object.","required":true,"items":{"type":"object","properties":{"_id":{"type":"string","description":"id","required":true},"action":{"type":"string","description":"action","required":true,"enum":["update"]},"data":{"type":"object","description":"data","required":true}}}}}},"example":{"items":[]}}}}}},"/api/collections/{namespace}/{slug}-{id}/items/{itemId}":{"delete":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"itemId","in":"path","description":"item Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/items/{itemId}"},"summary":"Delete item","description":"Delete an item from a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"itemId","in":"path","description":"item Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/items/{itemId}"},"summary":"Update item","description":"Update an item in a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"gallery":{"type":"array","description":"gallery","items":{"type":"string"}},"note":{"type":"string","description":"note"},"position":{"type":"number","description":"position"}}},"example":{"gallery":[],"note":"","position":""}}}}}},"/api/collections/{namespace}/{slug}-{id}/resource-group":{"get":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/resource-group"},"summary":"Get collection resource group","description":"Get collection resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Collections"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}-{id}/resource-group"},"summary":"Set collection resource group","description":"Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to assign the collection to. If null, the collection is removed from any resource group.","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/collections/{namespace}/{slug}/items":{"post":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/items"},"summary":"Add item (Collections POST)","description":"Add an item to a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"item":{"type":"object","description":"item","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["paper","collection","space","model","dataset","bucket"]},"id":{"type":"string","description":"id","required":true}}},"note":{"type":"string","description":"note"}}},"example":{"item":{},"note":""}}}}}},"/api/collections/{namespace}/{slug}/items/batch":{"post":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/items/batch"},"summary":"Batch update items (Collections POST)","description":"Batch update items in a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"items":{"type":"array","description":"The request body array. Send the bare JSON array itself as the request body, not wrapped in an object.","required":true,"items":{"type":"object","properties":{"_id":{"type":"string","description":"id","required":true},"action":{"type":"string","description":"action","required":true,"enum":["update"]},"data":{"type":"object","description":"data","required":true}}}}}},"example":{"items":[]}}}}}},"/api/collections/{namespace}/{slug}/items/{slug}":{"delete":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/items/{slug}"},"summary":"Delete item (Collections DELETE)","description":"Delete an item from a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/items/{slug}"},"summary":"Update item (Collections PATCH)","description":"Update an item in a collection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"gallery":{"type":"array","description":"gallery","items":{"type":"string"}},"note":{"type":"string","description":"note"},"position":{"type":"number","description":"position"}}},"example":{"gallery":[],"note":"","position":""}}}}}},"/api/collections/{namespace}/{slug}/resource-group":{"get":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/resource-group"},"summary":"Get collection resource group (Collections GET)","description":"Get collection resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Collections"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"slug","in":"path","description":"slug","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/collections/{namespace}/{slug}/resource-group"},"summary":"Set collection resource group (Collections POST)","description":"Assign, move, or unassign an organization-owned collection to a resource group. Pass null to unassign. User-owned collections are not eligible. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to assign the collection to. If null, the collection is removed from any resource group.","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/credentials/revoke":{"post":{"tags":["Tokens"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/credentials/revoke"},"summary":"Revoke leaked tokens","description":"Publicly invalidate leaked Hugging Face access tokens. Possession of the raw token value is the only proof required: no authentication is needed, and no rights over the owning account or org are necessary. Each raw token is fully invalidated, the owning user is notified by email. Always returns 202, whether or not any of the provided tokens existed, so the response cannot be used to probe token validity. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"credentials":{"type":"array","description":"Raw access token values to invalidate, at most 1000.","required":true,"items":{"type":"string"}}}},"example":{"credentials":[]}}}}}},"/api/daily_papers":{"get":{"tags":["Papers"],"parameters":[{"name":"date","in":"query","description":"date (ISO 8601 date format)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"month","in":"query","description":"month","required":false,"schema":{"type":"string","example":""}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["publishedAt","trending"]}}},{"name":"submitter","in":"query","description":"submitter","required":false,"schema":{"type":"string","example":""}},{"name":"week","in":"query","description":"week","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/daily_papers"},"summary":"Get Daily Papers","description":"Get Daily Papers Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets-tags-by-type":{"get":{"tags":["Datasets"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["benchmark","task_categories","size_categories","modality","format","library","language","license","arxiv","doi","region","other","task_ids","annotations_creators","language_creators","multilinguality","source_datasets"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets-tags-by-type"},"summary":"Get dataset tags","description":"Get all possible tags used for datasets, grouped by tag type. Optionally restrict to only one tag type Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/branch/{rev}":{"delete":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/branch/{rev}"},"summary":"Delete a branch","description":"Delete a branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/branch/{rev}"},"summary":"Create branch","description":"Create branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emptyBranch":{"type":"boolean","description":"Create an empty branch","enum":[true,false]},"overwrite":{"type":"boolean","description":"Overwrite the branch if it already exists","enum":[true,false]},"startingPoint":{"type":"string","description":"The commit to start from"}}},"example":{"emptyBranch":"","overwrite":"","startingPoint":""}}}}}},"/api/datasets/{namespace}/{repo}/commit/{rev}":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"create_pr","in":"query","description":"Whether to create a pull request from the commit","required":false,"schema":{"type":"string","example":""}},{"name":"hot_reload","in":"query","description":"For Spaces, whether to try to hot reload the commit (only for single python files updates)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/commit/{rev}"},"summary":"Commit","description":"For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { \"key\": \"header\", \"value\": { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" } } { \"key\": \"file\", \"value\": { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } { \"key\": \"deletedEntry\", \"value\": { \"path\": \"string (REQUIRED)\" } } { \"key\": \"lfsFile\", \"value\": { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } ``` JSON payload: ```json { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" \"files\": [ { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ], \"deletedEntries\": [ { \"path\": \"string (REQUIRED)\" } ], \"lfsFiles\": [ { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ] } ``` Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/datasets/{namespace}/{repo}/commits/{rev}":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"expand","required":false,"schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/commits/{rev}"},"summary":"List commits","description":"List commits Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/compare/{compare}":{"get":{"tags":["Datasets"],"parameters":[{"name":"compare","in":"path","description":"compare","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"raw","in":"query","description":"raw","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/compare/{compare}"},"summary":"Get a compare rev","description":"Get a compare rev Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/jwt":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"billing_details","in":"query","description":"billing details","required":false,"schema":{"type":"string","example":""}},{"name":"encrypted","in":"query","description":"encrypted","required":false,"schema":{"type":"string","example":""}},{"name":"expiration","in":"query","description":"Requested expiration datetime, capped at the default (10 minutes with write, 24 hours for spaces, 1 hour otherwise). Use expires_in instead. (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"expires_in","in":"query","description":"Requested lifetime in seconds, capped at the default (600s with write, 86400s for spaces, 3600s otherwise)","required":false,"schema":{"type":"number","example":""}},{"name":"include_pro_status","in":"query","description":"Use billing_details instead.","required":false,"schema":{"type":"string","example":""}},{"name":"inference_api","in":"query","description":"inference api","required":false,"schema":{"type":"string","example":""}},{"name":"write","in":"query","description":"write","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/jwt"},"summary":"Generate JWT","description":"Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/leaderboard":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"base_model","in":"query","description":"base model","required":false,"schema":{"type":"string","example":""}},{"name":"max_params","in":"query","description":"max params","required":false,"schema":{"type":"string","example":""}},{"name":"task_id","in":"query","description":"task id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/leaderboard"},"summary":"Get dataset leaderboard","description":"Returns the evaluation results ranked by score for a dataset/task Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/lfs-files":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["size","pushedAt"]}}},{"name":"xet","in":"query","description":"xet","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/lfs-files"},"summary":"List Large files","description":"List Xet/LFS files for a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/lfs-files/batch":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/lfs-files/batch"},"summary":"Delete Large files","description":"Delete Xet/LFS files in batch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletions":{"type":"object","description":"deletions","required":true,"properties":{"rewriteHistory":{"type":"boolean","description":"rewrite History","enum":[true,false]},"sha":{"type":"array","description":"sha","required":true}}}}},"example":{"deletions":{}}}}}}},"/api/datasets/{namespace}/{repo}/lfs-files/duplicate":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/lfs-files/duplicate"},"summary":"Duplicate xet files (Datasets POST)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"filename":{"type":"string","description":"filename"},"sha256":{"type":"string","description":"sha256","required":true},"xetHash":{"type":"string","description":"xet Hash","required":true}}}},"target":{"type":"object","description":"target","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","kernel"]},"name":{"type":"string","description":"name","required":true}}}}},"example":{"files":[],"target":{}}}}}}},"/api/datasets/{namespace}/{repo}/lfs-files/{sha}":{"delete":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"sha","in":"path","description":"sha","required":true,"schema":{"type":"string","example":""}},{"name":"rewriteHistory","in":"query","description":"rewrite History","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/lfs-files/{sha}"},"summary":"Delete Large file","description":"Delete a Xet/LFS file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/datasets/{namespace}/{repo}/notebook/{rev}/{path}":{"get":{"tags":["Datasets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/notebook/{rev}/{path}"},"summary":"Get notebook URL","description":"Get a jupyter notebook URL for the requested file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/paths-info/{rev}":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/paths-info/{rev}"},"summary":"List paths info (Datasets POST)","description":"List paths info Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expand":{"type":"object","description":"Expand the response with the last commit and security file status","required":true,"properties":{}},"paths":{"type":"object","description":"paths","required":true,"properties":{}}}},"example":{"expand":{},"paths":{}}}}}}},"/api/datasets/{namespace}/{repo}/preupload/{rev}":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/preupload/{rev}"},"summary":"Check upload method","description":"Check if a file should be uploaded through the Large File mechanism or directly. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"path":{"type":"string","description":"path","required":true},"sample":{"type":"string","description":"sample","required":true},"size":{"type":"number","description":"size","required":true}}}},"gitAttributes":{"type":"string","description":"Provide this parameter if you plan to modify `.gitattributes` yourself at the same time as uploading LFS files. Note that this is not needed if you solely rely on automatic LFS detection from HF: the commit endpoint will automatically edit the `.gitattributes` file to track the files passed to its `lfsFiles` param."},"gitIgnore":{"type":"string","description":"Content of the .gitignore file for the revision. Optional, otherwise takes the existing content of `.gitignore` for the revision."}}},"example":{"files":[],"gitAttributes":"","gitIgnore":""}}}}}},"/api/datasets/{namespace}/{repo}/refs":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"include_prs","in":"query","description":"include prs","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/refs"},"summary":"List references","description":"List references Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/resource-group":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/resource-group"},"summary":"Get resource group (Datasets GET)","description":"Get resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/resource-group"},"summary":"Add resource group (Datasets POST)","description":"Add the repository to a resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to add the repository to, if null, the repository will be removed from the resource group","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/datasets/{namespace}/{repo}/scan":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/scan"},"summary":"Get security status","description":"Get the security status of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/settings":{"put":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/settings"},"summary":"Update repo settings","description":"Update the settings of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"discussionsDisabled":{"type":"boolean","description":"discussions Disabled","enum":[true,false]},"discussionsSorting":{"type":"string","description":"discussions Sorting","enum":["recently-created","trending","reactions"]},"gated":{"type":"object","description":"gated","properties":{}},"gatedNotificationsEmail":{"type":"string","description":"gated Notifications Email"},"gatedNotificationsMode":{"type":"string","description":"gated Notifications Mode","enum":["bulk","real-time"]},"orgMembersGated":{"type":"boolean","description":"If true, members of the owning org (except admins) must also go through the gated access-request flow.","enum":[true,false]},"private":{"type":"boolean","description":"private","enum":[true,false]},"visibility":{"type":"string","description":"Repository visibility. `protected` is only supported for Spaces.","enum":["private","public","protected"]}}},"example":{"discussionsDisabled":"","discussionsSorting":"","gated":{},"gatedNotificationsEmail":"","gatedNotificationsMode":"","orgMembersGated":"","private":"","visibility":""}}}}}},"/api/datasets/{namespace}/{repo}/super-squash/{rev}":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/super-squash/{rev}"},"summary":"Squash ref","description":"Squash all commits in the current ref into a single commit with the given message. Action is irreversible. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"}}},"example":{"message":""}}}}}},"/api/datasets/{namespace}/{repo}/tag/{rev}":{"delete":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/tag/{rev}"},"summary":"Delete a tag","description":"Delete a tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/tag/{rev}"},"summary":"Create tag","description":"Create tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"},"tag":{"type":"string","description":"tag","required":true}}},"example":{"message":"","tag":""}}}}}},"/api/datasets/{namespace}/{repo}/tree/{rev}/{path}":{"get":{"tags":["Datasets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"If true, returns returns associated commit data for each entry and security scanner metadata.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"1.000 by default, 100 by default for expand=true","required":false,"schema":{"type":"number","example":""}},{"name":"recursive","in":"query","description":"If true, returns the tree recursively.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/tree/{rev}/{path}"},"summary":"List folder content","description":"List the content of a repository tree, with pagination support. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/treesize/{rev}/{path}":{"get":{"tags":["Datasets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/treesize/{rev}/{path}"},"summary":"Get folder size","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/user-access-request/batch":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/user-access-request/batch"},"summary":"Batch handle access requests","description":"Accept, reject or reset to pending up to 100 access requests for a single gated repository in one call. The same `status` (and optional `rejectionReason`) is applied to every request in the list. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rejectionReason":{"type":"string","description":"rejection Reason"},"requests":{"type":"array","description":"requests","required":true,"items":{"type":"object","properties":{"user":{"type":"string","description":"Either userId or user must be provided"},"userId":{"type":"string","description":"Either userId or user must be provided"}}}},"status":{"type":"string","description":"status","required":true,"enum":["accepted","rejected","pending"]}}},"example":{"rejectionReason":"","requests":[],"status":""}}}}}},"/api/datasets/{namespace}/{repo}/user-access-request/cancel":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/user-access-request/cancel"},"summary":"Cancel access request","description":"Cancel the current user's access request to a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/datasets/{namespace}/{repo}/user-access-request/grant":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/user-access-request/grant"},"summary":"Grant access","description":"Grant access to a user for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"user":{"type":"string","description":"user"},"userId":{"type":"string","description":"user Id"}}},"example":{"user":"","userId":""}}}}}},"/api/datasets/{namespace}/{repo}/user-access-request/handle":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/user-access-request/handle"},"summary":"Handle access request","description":"Handle a user's access request to a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rejectionReason":{"type":"string","description":"rejection Reason"},"status":{"type":"string","description":"status","required":true,"enum":["accepted","rejected","pending"]},"user":{"type":"string","description":"Either userId or user must be provided"},"userId":{"type":"string","description":"Either userId or user must be provided"}}},"example":{"rejectionReason":"","status":"","user":"","userId":""}}}}}},"/api/datasets/{namespace}/{repo}/user-access-request/{status}":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"status","in":"path","description":"status","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pending","accepted","rejected"]}}},{"name":"after","in":"query","description":"after (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"before (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Search requests by requester username, fullname, email, email domain or verified organization","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/user-access-request/{status}"},"summary":"List access requests","description":"List access requests for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/xet-read-token/{rev}":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/xet-read-token/{rev}"},"summary":"Xet read token (Datasets GET)","description":"Get a read short-lived access token for XET Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/datasets/{namespace}/{repo}/xet-write-token/{rev}":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/datasets/{namespace}/{repo}/xet-write-token/{rev}"},"summary":"Xet write token (Datasets GET)","description":"Get a write short-lived access token for XET upload Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/docs":{"get":{"tags":["Docs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/docs"},"summary":"List docs","description":"Get list of available documentation Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/docs/search":{"get":{"tags":["Docs"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"product","in":"query","description":"product","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["hub","transformers","diffusers","datasets","gradio","trackio","smolagents","huggingface_hub","cli","huggingface.js","transformers.js","inference-providers","inference-endpoints","peft","accelerate","optimum","optimum-habana","optimum-neuron","optimum-intel","optimum-executorch","optimum-tpu","tokenizers","llm-course","context-course","robotics-course","mcp-course","smol-course","agents-course","deep-rl-course","computer-vision-course","evaluate","tasks","dataset-viewer","trl","openenv","simulate","sagemaker","timm","safetensors","tgi","setfit","audio-course","lerobot","reachy_mini","autotrain","tei","bitsandbytes","cookbook","sentence_transformers","ml-games-course","diffusion-course","ml-for-3d-course","chat-ui","leaderboards","lighteval","argilla","distilabel","microsoft-azure","kernels","google-cloud","xet"]}}},{"name":"q","in":"query","description":"q","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/docs/search"},"summary":"Search docs","description":"Search any Hugging Face documentation Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/docs/search/full-text":{"get":{"tags":["Docs"],"parameters":[{"name":"domain","in":"query","description":"domain","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"q","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/docs/search/full-text"},"summary":"Full-text search docs","description":"Full-text search across Hugging Face documentation Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/inference-endpoints/{namespace}/auth-check/{perms}":{"post":{"tags":["Inference Endpoints"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"perms","in":"path","description":"perms","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["read","write","infer"]}}},{"name":"creator_id","in":"query","description":"creator id","required":false,"schema":{"type":"string","example":""}},{"name":"incur_cost","in":"query","description":"incur cost","required":false,"schema":{"type":"string","example":""}},{"name":"is_creator","in":"query","description":"is creator","required":false,"schema":{"type":"string","example":""}},{"name":"own","in":"query","description":"own","required":false,"schema":{"type":"string","example":""}},{"name":"repo_id","in":"query","description":"repo id","required":false,"schema":{"type":"string","example":""}},{"name":"resource_group_id","in":"query","description":"resource group id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/inference-endpoints/{namespace}/auth-check/{perms}"},"summary":"Check access","description":"Check if the user has access to the inference endpoint Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/inference-endpoints/{namespace}/{endpoint_name}/auth-check/{perms}":{"post":{"tags":["Inference Endpoints"],"parameters":[{"name":"endpoint_name","in":"path","description":"endpoint name (named 'endpoint' in the Hub API spec)","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"perms","in":"path","description":"perms","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["read","write","infer"]}}},{"name":"creator_id","in":"query","description":"creator id","required":false,"schema":{"type":"string","example":""}},{"name":"incur_cost","in":"query","description":"incur cost","required":false,"schema":{"type":"string","example":""}},{"name":"is_creator","in":"query","description":"is creator","required":false,"schema":{"type":"string","example":""}},{"name":"own","in":"query","description":"own","required":false,"schema":{"type":"string","example":""}},{"name":"repo_id","in":"query","description":"repo id","required":false,"schema":{"type":"string","example":""}},{"name":"resource_group_id","in":"query","description":"resource group id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/inference-endpoints/{namespace}/{endpoint_name}/auth-check/{perms}"},"summary":"Check access (Inference Endpoints POST)","description":"Check if the user has access to the inference endpoint Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/jobs/hardware":{"get":{"tags":["Jobs"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/hardware"},"summary":"Get job hardware","description":"Get available job hardware Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/jobs/{namespace}":{"get":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Pagination cursor obtained from the `rel=\"next\"` link of a previous response's `Link` header.","required":false,"schema":{"type":"string","example":""}},{"name":"label","in":"query","description":"Filter jobs by label. Format: 'key=value' (e.g., 'environment=production'). Repeat the parameter to filter by several labels.","required":false,"schema":{"type":"object","example":""}},{"name":"stage","in":"query","description":"Filter jobs by status stage. Repeat the parameter to filter by several stages.","required":false,"schema":{"type":"object","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}"},"summary":"List jobs","description":"List of jobs for an entity Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}"},"summary":"Start a job","description":"Start a job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"arch":{"type":"string","description":"arch","enum":["amd64","arm64"]},"arguments":{"type":"array","description":"arguments","items":{"type":"string"}},"attempts":{"type":"number","description":"Max number of attempts to make. For example, if you set this to 3, the job will be retried up to 2 times if it fails."},"command":{"type":"array","description":"command","items":{"type":"string"}},"dockerImage":{"type":"string","description":"docker Image"},"environment":{"type":"object","description":"environment","properties":{}},"expose":{"type":"object","description":"Ports to expose publicly through the jobs proxy. Each port is reachable at `https:// -- . `. Access requires a HF token with read access to the job's namespace, except for ports also listed in `portsPublic`.","properties":{"ports":{"type":"array","description":"ports","required":true},"portsPublic":{"type":"array","description":"Subset of `ports` reachable without any authentication."}}},"flavor":{"type":"string","description":"flavor","required":true,"enum":["cpu-basic","cpu-upgrade","cpu-performance","cpu-xl","sprx8","zero-a10g","t4-small","t4-medium","l4x1","l4x4","l40sx1","l40sx4","l40sx8","a10g-small","a10g-large","a10g-largex2","a10g-largex4","a100-large","a100x4","a100x8","h200","h200x2","h200x4","h200x8","rtx-pro-6000","rtx-pro-6000x2","rtx-pro-6000x4","rtx-pro-6000x8","inf2x6"]},"labels":{"type":"object","description":"Labels for the job as key-value pairs. Both keys and values must be max 100 characters and contain only alphanumeric characters, dots, dashes, and underscores.","properties":{}},"resourceGroupId":{"type":"string","description":"resource Group Id"},"secrets":{"type":"object","description":"secrets","properties":{}},"spaceId":{"type":"string","description":"space Id"},"ssh":{"type":"object","description":"When `enabled`, the job's container is reachable over SSH at `ssh @ssh.hf.jobs`. Only the job's owner is allowed in, authenticated by an SSH public key registered on the Hub.","properties":{"enabled":{"type":"boolean","description":"enabled","enum":[true,false]}}},"timeoutSeconds":{"type":"object","description":"timeout Seconds","properties":{}},"volumes":{"type":"array","description":"HuggingFace Buckets or Repos to mount as volumes in the job container.","items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["bucket","model","dataset","space"]},"path":{"type":"string","description":"Subfolder prefix inside the bucket/repo to mount, e.g. 'path/to/dir'"},"mountPath":{"type":"string","description":"Mount path inside the container, e.g. '/data'","required":true},"readOnly":{"type":"boolean","description":"Read-only mount (true for repos, false default for buckets)","enum":[true,false]},"revision":{"type":"string","description":"Git revision (only for repos, defaults to 'main')"},"source":{"type":"string","description":"Source identifier, e.g. 'username/my-bucket' or 'username/my-model'","required":true}}}}}},"example":{"arch":"","arguments":[],"attempts":1,"command":[],"dockerImage":"","environment":{},"expose":{},"flavor":"","labels":{},"resourceGroupId":"","secrets":{},"spaceId":"","ssh":{},"timeoutSeconds":{},"volumes":[]}}}}}},"/api/jobs/{namespace}/auth-check/{perms}":{"post":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"perms","in":"path","description":"perms","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["read","write"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/auth-check/{perms}"},"summary":"Check access (Jobs POST)","description":"Check if the user has access to jobs in the namespace Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/jobs/{namespace}/count":{"get":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"stage","in":"query","description":"stage","required":false,"schema":{"type":"object","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/count"},"summary":"Count jobs","description":"Count the number of jobs for an entity with optional status stage filter Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/jobs/{namespace}/{jobId}":{"get":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}"},"summary":"Get a job","description":"Get a job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/jobs/{namespace}/{jobId}/auth-check/{perms}":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"perms","in":"path","description":"perms","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["read","write"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/auth-check/{perms}"},"summary":"Check access (Jobs POST) — POST /api/jobs/{namespace}/{jobId}/auth-check/{perms}","description":"Check if the user has access to jobs in the namespace Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/jobs/{namespace}/{jobId}/cancel":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/cancel"},"summary":"Cancel a job","description":"Cancel a job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/jobs/{namespace}/{jobId}/duplicate":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/duplicate"},"summary":"Duplicate a job","description":"Duplicate an existing job, re-using its spec Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/jobs/{namespace}/{jobId}/events":{"get":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/events"},"summary":"Stream job events","description":"Stream the events of a job, using SSE Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/jobs/{namespace}/{jobId}/expose":{"put":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/expose"},"summary":"Update job exposed ports","description":"Replace the exposed ports of a running job, applied live (no re-run). Ports listed in `portsPublic` are reachable without any authentication. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ports":{"type":"array","description":"ports","required":true,"items":{"type":"number"}},"portsPublic":{"type":"array","description":"Subset of `ports` reachable without any authentication.","items":{"type":"number"}}}},"example":{"ports":[],"portsPublic":[]}}}}}},"/api/jobs/{namespace}/{jobId}/labels":{"put":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/labels"},"summary":"Update job labels","description":"Replace user-provided labels on a job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"object","description":"The new labels to set on the job. Replaces all existing labels.","required":true,"properties":{}}}},"example":{"labels":{}}}}}}},"/api/jobs/{namespace}/{jobId}/logs":{"get":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"tail","in":"query","description":"Maximum number of lines to return from the logs.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/logs"},"summary":"Stream job logs","description":"Stream the logs of a job, using SSE Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/jobs/{namespace}/{jobId}/metrics":{"get":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/jobs/{namespace}/{jobId}/metrics"},"summary":"Stream job metrics","description":"Stream the metrics of a job, using SSE Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/kernels":{"get":{"tags":["Kernels"],"parameters":[{"name":"arxivIds","in":"query","description":"Filter by Arxiv ID","required":false,"schema":{"type":"object","example":""}},{"name":"author","in":"query","description":"Filter by author","required":false,"schema":{"type":"object","example":""}},{"name":"cursor","in":"query","description":"Pagination cursor from Link header","required":false,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"Sort direction: 1 for ascending, -1 for descending","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["1","-1"]}}},{"name":"expand","in":"query","description":"Display specific fields in the response","required":false,"schema":{"type":"object","example":""}},{"name":"filter","in":"query","description":"Filter by tags","required":false,"schema":{"type":"object","example":""}},{"name":"full","in":"query","description":"Return full kernel info including author, sha, lastModified, files, gated","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"gated","in":"query","description":"Filter by gated","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"id","in":"query","description":"Filter by ID","required":false,"schema":{"type":"object","example":""}},{"name":"limit","in":"query","description":"Maximum number of results to return","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter by search term","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sort field (e.g. downloads, likes, lastModified, trendingScore)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["downloads","likes","lastModified","trendingScore","likes30d","_id","id"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/kernels"},"summary":"List kernels","description":"List kernels with optional filtering, sorting, and pagination Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/kernels/{namespace}/{repo}":{"get":{"tags":["Kernels"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/kernels/{namespace}/{repo}"},"summary":"Get kernel","description":"Get kernel Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/kernels/{namespace}/{repo}/lfs-files/duplicate":{"post":{"tags":["Kernels"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/kernels/{namespace}/{repo}/lfs-files/duplicate"},"summary":"Duplicate xet files (Kernels POST)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"filename":{"type":"string","description":"filename"},"sha256":{"type":"string","description":"sha256","required":true},"xetHash":{"type":"string","description":"xet Hash","required":true}}}},"target":{"type":"object","description":"target","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","kernel"]},"name":{"type":"string","description":"name","required":true}}}}},"example":{"files":[],"target":{}}}}}}},"/api/kernels/{namespace}/{repo}/revision/{rev}":{"get":{"tags":["Kernels"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/kernels/{namespace}/{repo}/revision/{rev}"},"summary":"Get kernel (Kernels GET)","description":"Get kernel Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models-tags-by-type":{"get":{"tags":["Models"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pipeline_tag","library","dataset","bucket","language","license","arxiv","doi","region","deploy","other"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models-tags-by-type"},"summary":"Get model tags","description":"Get all possible tags used for models, grouped by tag type. Optionally restrict to only one tag type Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/branch/{rev}":{"delete":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/branch/{rev}"},"summary":"Delete a branch (Models DELETE)","description":"Delete a branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/branch/{rev}"},"summary":"Create branch (Models POST)","description":"Create branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emptyBranch":{"type":"boolean","description":"Create an empty branch","enum":[true,false]},"overwrite":{"type":"boolean","description":"Overwrite the branch if it already exists","enum":[true,false]},"startingPoint":{"type":"string","description":"The commit to start from"}}},"example":{"emptyBranch":"","overwrite":"","startingPoint":""}}}}}},"/api/models/{namespace}/{repo}/commit/{rev}":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"create_pr","in":"query","description":"Whether to create a pull request from the commit","required":false,"schema":{"type":"string","example":""}},{"name":"hot_reload","in":"query","description":"For Spaces, whether to try to hot reload the commit (only for single python files updates)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/commit/{rev}"},"summary":"Commit (Models POST)","description":"For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { \"key\": \"header\", \"value\": { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" } } { \"key\": \"file\", \"value\": { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } { \"key\": \"deletedEntry\", \"value\": { \"path\": \"string (REQUIRED)\" } } { \"key\": \"lfsFile\", \"value\": { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } ``` JSON payload: ```json { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" \"files\": [ { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ], \"deletedEntries\": [ { \"path\": \"string (REQUIRED)\" } ], \"lfsFiles\": [ { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ] } ``` Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/models/{namespace}/{repo}/commits/{rev}":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"expand","required":false,"schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/commits/{rev}"},"summary":"List commits (Models GET)","description":"List commits Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/compare/{compare}":{"get":{"tags":["Models"],"parameters":[{"name":"compare","in":"path","description":"compare","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"raw","in":"query","description":"raw","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/compare/{compare}"},"summary":"Get a compare rev (Models GET)","description":"Get a compare rev Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/jwt":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"billing_details","in":"query","description":"billing details","required":false,"schema":{"type":"string","example":""}},{"name":"encrypted","in":"query","description":"encrypted","required":false,"schema":{"type":"string","example":""}},{"name":"expiration","in":"query","description":"Requested expiration datetime, capped at the default (10 minutes with write, 24 hours for spaces, 1 hour otherwise). Use expires_in instead. (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"expires_in","in":"query","description":"Requested lifetime in seconds, capped at the default (600s with write, 86400s for spaces, 3600s otherwise)","required":false,"schema":{"type":"number","example":""}},{"name":"include_pro_status","in":"query","description":"Use billing_details instead.","required":false,"schema":{"type":"string","example":""}},{"name":"inference_api","in":"query","description":"inference api","required":false,"schema":{"type":"string","example":""}},{"name":"write","in":"query","description":"write","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/jwt"},"summary":"Generate JWT (Models GET)","description":"Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/lfs-files":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["size","pushedAt"]}}},{"name":"xet","in":"query","description":"xet","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/lfs-files"},"summary":"List Large files (Models GET)","description":"List Xet/LFS files for a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/lfs-files/batch":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/lfs-files/batch"},"summary":"Delete Large files (Models POST)","description":"Delete Xet/LFS files in batch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletions":{"type":"object","description":"deletions","required":true,"properties":{"rewriteHistory":{"type":"boolean","description":"rewrite History","enum":[true,false]},"sha":{"type":"array","description":"sha","required":true}}}}},"example":{"deletions":{}}}}}}},"/api/models/{namespace}/{repo}/lfs-files/duplicate":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/lfs-files/duplicate"},"summary":"Duplicate xet files (Models POST)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"filename":{"type":"string","description":"filename"},"sha256":{"type":"string","description":"sha256","required":true},"xetHash":{"type":"string","description":"xet Hash","required":true}}}},"target":{"type":"object","description":"target","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","kernel"]},"name":{"type":"string","description":"name","required":true}}}}},"example":{"files":[],"target":{}}}}}}},"/api/models/{namespace}/{repo}/lfs-files/{sha}":{"delete":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"sha","in":"path","description":"sha","required":true,"schema":{"type":"string","example":""}},{"name":"rewriteHistory","in":"query","description":"rewrite History","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/lfs-files/{sha}"},"summary":"Delete Large file (Models DELETE)","description":"Delete a Xet/LFS file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/models/{namespace}/{repo}/notebook/{rev}/{path}":{"get":{"tags":["Models"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/notebook/{rev}/{path}"},"summary":"Get notebook URL (Models GET)","description":"Get a jupyter notebook URL for the requested file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/paths-info/{rev}":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/paths-info/{rev}"},"summary":"List paths info (Models POST)","description":"List paths info Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expand":{"type":"object","description":"Expand the response with the last commit and security file status","required":true,"properties":{}},"paths":{"type":"object","description":"paths","required":true,"properties":{}}}},"example":{"expand":{},"paths":{}}}}}}},"/api/models/{namespace}/{repo}/preupload/{rev}":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/preupload/{rev}"},"summary":"Check upload method (Models POST)","description":"Check if a file should be uploaded through the Large File mechanism or directly. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"path":{"type":"string","description":"path","required":true},"sample":{"type":"string","description":"sample","required":true},"size":{"type":"number","description":"size","required":true}}}},"gitAttributes":{"type":"string","description":"Provide this parameter if you plan to modify `.gitattributes` yourself at the same time as uploading LFS files. Note that this is not needed if you solely rely on automatic LFS detection from HF: the commit endpoint will automatically edit the `.gitattributes` file to track the files passed to its `lfsFiles` param."},"gitIgnore":{"type":"string","description":"Content of the .gitignore file for the revision. Optional, otherwise takes the existing content of `.gitignore` for the revision."}}},"example":{"files":[],"gitAttributes":"","gitIgnore":""}}}}}},"/api/models/{namespace}/{repo}/refs":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"include_prs","in":"query","description":"include prs","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/refs"},"summary":"List references (Models GET)","description":"List references Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/resource-group":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/resource-group"},"summary":"Get resource group (Models GET)","description":"Get resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/resource-group"},"summary":"Add resource group (Models POST)","description":"Add the repository to a resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to add the repository to, if null, the repository will be removed from the resource group","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/models/{namespace}/{repo}/scan":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/scan"},"summary":"Get security status (Models GET)","description":"Get the security status of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/settings":{"put":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/settings"},"summary":"Update repo settings (Models PUT)","description":"Update the settings of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"discussionsDisabled":{"type":"boolean","description":"discussions Disabled","enum":[true,false]},"discussionsSorting":{"type":"string","description":"discussions Sorting","enum":["recently-created","trending","reactions"]},"gated":{"type":"object","description":"gated","properties":{}},"gatedNotificationsEmail":{"type":"string","description":"gated Notifications Email"},"gatedNotificationsMode":{"type":"string","description":"gated Notifications Mode","enum":["bulk","real-time"]},"orgMembersGated":{"type":"boolean","description":"If true, members of the owning org (except admins) must also go through the gated access-request flow.","enum":[true,false]},"private":{"type":"boolean","description":"private","enum":[true,false]},"visibility":{"type":"string","description":"Repository visibility. `protected` is only supported for Spaces.","enum":["private","public","protected"]}}},"example":{"discussionsDisabled":"","discussionsSorting":"","gated":{},"gatedNotificationsEmail":"","gatedNotificationsMode":"","orgMembersGated":"","private":"","visibility":""}}}}}},"/api/models/{namespace}/{repo}/super-squash/{rev}":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/super-squash/{rev}"},"summary":"Squash ref (Models POST)","description":"Squash all commits in the current ref into a single commit with the given message. Action is irreversible. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"}}},"example":{"message":""}}}}}},"/api/models/{namespace}/{repo}/tag/{rev}":{"delete":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/tag/{rev}"},"summary":"Delete a tag (Models DELETE)","description":"Delete a tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/tag/{rev}"},"summary":"Create tag (Models POST)","description":"Create tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"},"tag":{"type":"string","description":"tag","required":true}}},"example":{"message":"","tag":""}}}}}},"/api/models/{namespace}/{repo}/tree/{rev}/{path}":{"get":{"tags":["Models"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"If true, returns returns associated commit data for each entry and security scanner metadata.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"1.000 by default, 100 by default for expand=true","required":false,"schema":{"type":"number","example":""}},{"name":"recursive","in":"query","description":"If true, returns the tree recursively.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/tree/{rev}/{path}"},"summary":"List folder content (Models GET)","description":"List the content of a repository tree, with pagination support. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/treesize/{rev}/{path}":{"get":{"tags":["Models"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/treesize/{rev}/{path}"},"summary":"Get folder size (Models GET)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/user-access-request/batch":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/user-access-request/batch"},"summary":"Batch handle access requests (Models POST)","description":"Accept, reject or reset to pending up to 100 access requests for a single gated repository in one call. The same `status` (and optional `rejectionReason`) is applied to every request in the list. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rejectionReason":{"type":"string","description":"rejection Reason"},"requests":{"type":"array","description":"requests","required":true,"items":{"type":"object","properties":{"user":{"type":"string","description":"Either userId or user must be provided"},"userId":{"type":"string","description":"Either userId or user must be provided"}}}},"status":{"type":"string","description":"status","required":true,"enum":["accepted","rejected","pending"]}}},"example":{"rejectionReason":"","requests":[],"status":""}}}}}},"/api/models/{namespace}/{repo}/user-access-request/cancel":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/user-access-request/cancel"},"summary":"Cancel access request (Models POST)","description":"Cancel the current user's access request to a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/models/{namespace}/{repo}/user-access-request/grant":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/user-access-request/grant"},"summary":"Grant access (Models POST)","description":"Grant access to a user for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"user":{"type":"string","description":"user"},"userId":{"type":"string","description":"user Id"}}},"example":{"user":"","userId":""}}}}}},"/api/models/{namespace}/{repo}/user-access-request/handle":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/user-access-request/handle"},"summary":"Handle access request (Models POST)","description":"Handle a user's access request to a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"rejectionReason":{"type":"string","description":"rejection Reason"},"status":{"type":"string","description":"status","required":true,"enum":["accepted","rejected","pending"]},"user":{"type":"string","description":"Either userId or user must be provided"},"userId":{"type":"string","description":"Either userId or user must be provided"}}},"example":{"rejectionReason":"","status":"","user":"","userId":""}}}}}},"/api/models/{namespace}/{repo}/user-access-request/{status}":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"status","in":"path","description":"status","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["pending","accepted","rejected"]}}},{"name":"after","in":"query","description":"after (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"before (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Search requests by requester username, fullname, email, email domain or verified organization","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/user-access-request/{status}"},"summary":"List access requests (Models GET)","description":"List access requests for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/xet-read-token/{rev}":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/xet-read-token/{rev}"},"summary":"Xet read token (Models GET)","description":"Get a read short-lived access token for XET Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/models/{namespace}/{repo}/xet-write-token/{rev}":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/models/{namespace}/{repo}/xet-write-token/{rev}"},"summary":"Xet write token (Models GET)","description":"Get a write short-lived access token for XET upload Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/notifications":{"delete":{"tags":["Notifications"],"parameters":[{"name":"applyToAll","in":"query","description":"apply To All","required":false,"schema":{"type":"string","example":""}},{"name":"articleId","in":"query","description":"article Id","required":false,"schema":{"type":"string","example":""}},{"name":"lastUpdate","in":"query","description":"last Update (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"mention","in":"query","description":"mention","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","participating","mentions"]}}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}},{"name":"paperId","in":"query","description":"paper Id","required":false,"schema":{"type":"string","example":""}},{"name":"postAuthor","in":"query","description":"post Author","required":false,"schema":{"type":"string","example":""}},{"name":"readStatus","in":"query","description":"read Status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","unread"]}}},{"name":"repoName","in":"query","description":"repo Name","required":false,"schema":{"type":"string","example":""}},{"name":"repoType","in":"query","description":"repo Type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dataset","model","space","bucket","kernel"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/notifications"},"summary":"Delete notifications","description":"Delete notifications, either by specifying discussionIds or by applying to all notifications with search parameters Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"discussionIds":{"type":"array","description":"discussion Ids","items":{"type":"string"}}}},"example":{"discussionIds":[]}}}}},"get":{"tags":["Notifications"],"parameters":[{"name":"articleId","in":"query","description":"article Id","required":false,"schema":{"type":"string","example":""}},{"name":"lastUpdate","in":"query","description":"last Update (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"mention","in":"query","description":"mention","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","participating","mentions"]}}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}},{"name":"paperId","in":"query","description":"paper Id","required":false,"schema":{"type":"string","example":""}},{"name":"postAuthor","in":"query","description":"post Author","required":false,"schema":{"type":"string","example":""}},{"name":"readStatus","in":"query","description":"read Status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","unread"]}}},{"name":"repoName","in":"query","description":"repo Name","required":false,"schema":{"type":"string","example":""}},{"name":"repoType","in":"query","description":"repo Type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dataset","model","space","bucket","kernel"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/notifications"},"summary":"List notifications","description":"List notifications for the user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/notifications/mark-as-read":{"post":{"tags":["Notifications"],"parameters":[{"name":"applyToAll","in":"query","description":"apply To All","required":false,"schema":{"type":"string","example":""}},{"name":"articleId","in":"query","description":"article Id","required":false,"schema":{"type":"string","example":""}},{"name":"lastUpdate","in":"query","description":"last Update (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"mention","in":"query","description":"mention","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","participating","mentions"]}}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}},{"name":"paperId","in":"query","description":"paper Id","required":false,"schema":{"type":"string","example":""}},{"name":"postAuthor","in":"query","description":"post Author","required":false,"schema":{"type":"string","example":""}},{"name":"readStatus","in":"query","description":"read Status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","unread"]}}},{"name":"repoName","in":"query","description":"repo Name","required":false,"schema":{"type":"string","example":""}},{"name":"repoType","in":"query","description":"repo Type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dataset","model","space","bucket","kernel"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/notifications/mark-as-read"},"summary":"Change read status","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"discussionIds":{"type":"array","description":"discussion Ids","items":{"type":"string"}},"read":{"type":"boolean","description":"read","enum":[true,false]}}},"example":{"discussionIds":[],"read":true}}}}}},"/api/organizations/{name}/audit-log/export":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"q","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/audit-log/export"},"summary":"Export the audit log","description":"Export the audit log events in JSON format for a Team or Enterprise organization. The export is limited to the last 100,000 events. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/avatar":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"redirect","in":"query","description":"Redirect to the avatar url instead of returning it","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/avatar"},"summary":"Get avatar (Organizations GET)","description":"Retrieve organization avatar. This endpoint returns a JSON with the avatar URL for the organization. If called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/billing/usage":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"periodId","in":"query","description":"period Id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/billing/usage"},"summary":"Get org usage","description":"Get org usage for a given period Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/billing/usage-by-inference-session":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"end Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"start Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/billing/usage-by-inference-session"},"summary":"Get session inference usage","description":"Get org inference-provider usage broken down per session id, as a time-series of monthly periods. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/billing/usage-by-resource-group":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"end Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"start Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/billing/usage-by-resource-group"},"summary":"Get resource group usage","description":"Get org usage breakdown per resource group, returned as a time-series of monthly periods. Window is [startDate, endDate], defaults to the current month. Both dates must fall within the last 12 months. Storage values are the peak observed within each monthly period. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/billing/usage-v2":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"end Date","required":true,"schema":{"type":"number","example":""}},{"name":"startDate","in":"query","description":"start Date","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/billing/usage-v2"},"summary":"Get org usage (Organizations GET)","description":"Get org usage for a given period Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/billing/usage/live":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/billing/usage/live"},"summary":"Stream usage","description":"Get live usage for org Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/members":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"email","in":"query","description":"email","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/members"},"summary":"Get organization members","description":"Get a list of members for the organization with optional search and pagination. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/members/{username}/role":{"put":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/members/{username}/role"},"summary":"Change member role","description":"Change the role of a member in the organization. Need a paid plan. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroups":{"type":"array","description":"resource Groups","items":{"type":"object","properties":{"id":{"type":"string","description":"id","required":true},"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]}}}},"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]}}},"example":{"resourceGroups":[],"role":""}}}}}},"/api/organizations/{name}/resource-groups":{"get":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups"},"summary":"Get resource groups","description":"Retrieve accessible resource groups. Get all resource groups the user has access to. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups"},"summary":"Create resource group","description":"Create a new resource group in the organization. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"autoJoin":{"type":"object","description":"auto Join","properties":{"enabled":{"type":"string","description":"enabled","required":true,"enum":[false,true]},"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]},"scope":{"type":"string","description":"scope","enum":["all","read_plus"]}}},"description":{"type":"string","description":"description"},"name":{"type":"string","description":"name","required":true},"repos":{"type":"array","description":"repos","items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","bucket","kernel"]},"name":{"type":"string","description":"name","required":true}}}},"users":{"type":"array","description":"users","items":{"type":"object","properties":{"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]},"user":{"type":"string","description":"user","required":true}}}}}},"example":{"autoJoin":{},"description":"","name":"","repos":[],"users":[]}}}}}},"/api/organizations/{name}/resource-groups/{resourceGroupId}":{"delete":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}"},"summary":"Delete resource group","description":"Delete a resource group from the organization. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}"},"summary":"Get resource group (Resource Groups GET)","description":"Retrieve a single resource group by id. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}"},"summary":"Update resource group","description":"Update the name, description and/or monthly spend limits (in cents, `null` to remove) of a resource group. `spendLimits.total` caps the group's combined spend across every product; the per-product limits cap each product on top of it. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"name":{"type":"string","description":"name"},"spendLimits":{"type":"object","description":"spend Limits","properties":{"endpoints":{"type":"object","description":"endpoints"},"inferenceProviders":{"type":"object","description":"inference Providers"},"jobs":{"type":"object","description":"jobs"},"spaces":{"type":"object","description":"spaces"},"total":{"type":"object","description":"total"}}}}},"example":{"description":"","name":"","spendLimits":{}}}}}}},"/api/organizations/{name}/resource-groups/{resourceGroupId}/settings":{"post":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}/settings"},"summary":"Configure auto-join","description":"Configure the auto-join settings of a resource group. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"autoJoin":{"type":"object","description":"auto Join","properties":{"enabled":{"type":"object","description":"enabled","required":true},"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]},"scope":{"type":"string","description":"scope","enum":["all","read_plus"]}}}}},"example":{"autoJoin":{}}}}}}},"/api/organizations/{name}/resource-groups/{resourceGroupId}/users":{"post":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}/users"},"summary":"Add users","description":"Add one or more organization members to a resource group. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"users":{"type":"array","description":"users","required":true,"items":{"type":"string"}}}},"example":{"users":[]}}}}}},"/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}":{"delete":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}"},"summary":"Remove user","description":"Remove a user from a resource group, revoking the access granted through it. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Resource Groups"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"resourceGroupId","in":"path","description":"resource Group Id","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}"},"summary":"Change user role","description":"Change the role of a user in a resource group. Requires the org to have a Team plan or higher. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"role":{"type":"string","description":"role","required":true,"enum":["admin","write","contributor","read","no_access"]}}},"example":{"role":""}}}}}},"/api/organizations/{name}/scim-provisioning/v2/Groups":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"count","required":false,"schema":{"type":"number","example":""}},{"name":"excludedAttributes","in":"query","description":"excluded Attributes","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["members"]}}},{"name":"filter","in":"query","description":"filter","required":false,"schema":{"type":"string","example":""}},{"name":"startIndex","in":"query","description":"start Index","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups"},"summary":"List SCIM groups","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups"},"summary":"Create a SCIM group","description":"Creates a new group in the organization. The group name must be unique within the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"display Name","required":true},"externalId":{"type":"string","description":"external Id"},"members":{"type":"array","description":"Array of SCIM user ids","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}}}},"example":{"displayName":"","externalId":"","members":[]}}}}}},"/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}":{"delete":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}"},"summary":"Delete a SCIM group","description":"Delete a SCIM group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"excludedAttributes","in":"query","description":"excluded Attributes","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["members"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}"},"summary":"Get a SCIM group","description":"Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}"},"summary":"Update SCIM group","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Operations":{"type":"array","description":"Operations","required":true,"items":{"type":"string"}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"Operations":[],"schemas":[]}}}}},"put":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Groups/{groupId}"},"summary":"Update a SCIM group","description":"Updates a group by its ID. The group name must be unique within the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"display Name","required":true},"externalId":{"type":"string","description":"external Id"},"members":{"type":"array","description":"members","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"displayName":"","externalId":"","members":[],"schemas":[]}}}}}},"/api/organizations/{name}/scim-provisioning/v2/Users":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"count","required":false,"schema":{"type":"number","example":""}},{"name":"filter","in":"query","description":"You can filter results using the equals operator (eq) to find items that match specific values like `id`, `userName`, `emails`, and `externalId`. For example, to find a user named Bob, use this search: `?filter=userName%20eq%20Bob`","required":false,"schema":{"type":"string","example":""}},{"name":"startIndex","in":"query","description":"start Index","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users"},"summary":"List SCIM-managed users","description":"Retrieves a paginated list of organization members and pending invitations managed by SCIM for non-managed organizations. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users"},"summary":"Create SCIM invitation","description":"Creates an invitation for a user to join the organization. The user must have an existing Hugging Face account. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"active","enum":[true,false]},"emails":{"type":"array","description":"emails","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}},"externalId":{"type":"string","description":"SSO unique identifier (SAML nameid or OIDC sub claim) - required for SSO login","required":true},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}},"userName":{"type":"string","description":"Username of the existing Hugging Face user","required":true}}},"example":{"active":true,"emails":[],"externalId":"","schemas":[],"userName":""}}}}}},"/api/organizations/{name}/scim-provisioning/v2/Users/{userId}":{"delete":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users/{userId}"},"summary":"Delete SCIM user","description":"Removes a user from the organization and deletes any pending invitations for non-managed organizations. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users/{userId}"},"summary":"Get a SCIM provisioning user","description":"Retrieves a SCIM user by their ID for non-managed organizations. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users/{userId}"},"summary":"Update SCIM user","description":"Modify individual attributes for non-managed organizations. Only the `active` field can be modified. User profile fields are not editable via SCIM. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Operations":{"type":"array","description":"Operations","required":true,"items":{"type":"object","properties":{"path":{"type":"string","description":"path","enum":["active","externalId","userName","emails[type eq \"work\"].value","name.givenName","name.familyName"]},"op":{"type":"string","description":"`remove` operation is not supported for non-managed organizations","required":true,"enum":["add","remove","replace"]},"value":{"type":"string","description":"value","required":true}}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"Operations":[],"schemas":[]}}}}},"put":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim-provisioning/v2/Users/{userId}"},"summary":"Update a SCIM user","description":"Updates a provisioned user's invitation for non-managed organizations. User profile fields are not editable via SCIM for non-managed organizations. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"active","enum":[true,false]},"externalId":{"type":"string","description":"external Id","required":true},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"active":true,"externalId":"","schemas":[]}}}}}},"/api/organizations/{name}/scim/v2/Groups":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"count","required":false,"schema":{"type":"number","example":""}},{"name":"excludedAttributes","in":"query","description":"excluded Attributes","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["members"]}}},{"name":"filter","in":"query","description":"filter","required":false,"schema":{"type":"string","example":""}},{"name":"startIndex","in":"query","description":"start Index","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups"},"summary":"List SCIM groups (SCIM GET)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups"},"summary":"Create a SCIM group (SCIM POST)","description":"Creates a new group in the organization. The group name must be unique within the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"display Name","required":true},"externalId":{"type":"string","description":"external Id"},"members":{"type":"array","description":"Array of SCIM user ids","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}}}},"example":{"displayName":"","externalId":"","members":[]}}}}}},"/api/organizations/{name}/scim/v2/Groups/{groupId}":{"delete":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups/{groupId}"},"summary":"Delete a SCIM group (SCIM DELETE)","description":"Delete a SCIM group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"excludedAttributes","in":"query","description":"excluded Attributes","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["members"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups/{groupId}"},"summary":"Get a SCIM group (SCIM GET)","description":"Retrieves a group by its ID. If you provide the `excludedAttributes` parameter, the `members` attribute is not returned. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups/{groupId}"},"summary":"Update SCIM group (SCIM PATCH)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Operations":{"type":"array","description":"Operations","required":true,"items":{"type":"string"}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"Operations":[],"schemas":[]}}}}},"put":{"tags":["SCIM"],"parameters":[{"name":"groupId","in":"path","description":"group Id","required":true,"schema":{"type":"string","example":""}},{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Groups/{groupId}"},"summary":"Update a SCIM group (SCIM PUT)","description":"Updates a group by its ID. The group name must be unique within the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"display Name","required":true},"externalId":{"type":"string","description":"external Id"},"members":{"type":"array","description":"members","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"displayName":"","externalId":"","members":[],"schemas":[]}}}}}},"/api/organizations/{name}/scim/v2/ResourceTypes":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/ResourceTypes"},"summary":"Get SCIM Resource Types","description":"Returns the list of SCIM 2.0 resource types supported by this server (User and Group). Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/scim/v2/Schemas":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Schemas"},"summary":"Get SCIM Schemas","description":"Returns the SCIM 2.0 schema definitions for User and Group resources. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/scim/v2/Schemas/{schemaId}":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"schemaId","in":"path","description":"schema Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Schemas/{schemaId}"},"summary":"Get SCIM Schema by ID","description":"Returns a single SCIM 2.0 schema definition by its schema URI. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/scim/v2/ServiceProviderConfig":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/ServiceProviderConfig"},"summary":"Get SCIM Configuration","description":"Returns the SCIM 2.0 Service Provider configuration, describing the server's capabilities and supported authentication schemes. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/scim/v2/Users":{"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"count","in":"query","description":"count","required":false,"schema":{"type":"number","example":""}},{"name":"filter","in":"query","description":"You can filter results using the equals operator (eq) to find items that match specific values like `id`, `userName`, `emails`, and `externalId`. For example, to find a user named Bob, use this search: `?filter=userName%20eq%20Bob`","required":false,"schema":{"type":"string","example":""}},{"name":"startIndex","in":"query","description":"start Index","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users"},"summary":"List SCIM users","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users"},"summary":"Create a SCIM user","description":"Creates a new user in the organization. If the user already exists, only `active` field will be updated to provision the user. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"active","enum":[true,false]},"emails":{"type":"array","description":"emails","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}},"externalId":{"type":"string","description":"External ID for the user, it must be unique within the organization and is required for managed users","required":true},"name":{"type":"object","description":"name","required":true,"properties":{"familyName":{"type":"string","description":"family Name","required":true},"givenName":{"type":"string","description":"given Name","required":true}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}},"userName":{"type":"string","description":"Username for the user, it should respect the hub rules: No consecutive dashes, No digit-only, Does not start or end with a dash, Only dashes, letters or numbers, Not 24 chars hex string","required":true}}},"example":{"active":true,"emails":[],"externalId":"","name":{},"schemas":[],"userName":""}}}}}},"/api/organizations/{name}/scim/v2/Users/{userId}":{"delete":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users/{userId}"},"summary":"Delete a SCIM user","description":"Delete a SCIM user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users/{userId}"},"summary":"Get a SCIM user","description":"Retrieves a SCIM user by their ID. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users/{userId}"},"summary":"Update SCIM user (SCIM PATCH)","description":"Update an attribute of a SCIM user. Modify individual attributes using Operations format. Just provide the changes you want to make using add, remove (only `externalId` is supported), or replace operations. If you set `active` to `false`, the user will be deprovisioned from the organization. Complicated SCIM `path` values are not supported like `emails[type eq 'work'].value`. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Operations":{"type":"array","description":"Operations","required":true,"items":{"type":"object","properties":{"path":{"type":"string","description":"path","enum":["active","externalId","userName","emails[type eq \"work\"].value","name.givenName","name.familyName"]},"op":{"type":"string","description":"op","required":true},"value":{"type":"string","description":"value","required":true}}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}}}},"example":{"Operations":[],"schemas":[]}}}}},"put":{"tags":["SCIM"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"path","description":"user Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/scim/v2/Users/{userId}"},"summary":"Update a SCIM user (SCIM PUT)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"active","enum":[true,false]},"emails":{"type":"array","description":"emails","required":true,"items":{"type":"object","properties":{"value":{"type":"string","description":"value","required":true}}}},"externalId":{"type":"string","description":"external Id","required":true},"name":{"type":"object","description":"name","required":true,"properties":{"familyName":{"type":"string","description":"family Name","required":true},"givenName":{"type":"string","description":"given Name","required":true}}},"schemas":{"type":"array","description":"schemas","required":true,"items":{"type":"string"}},"userName":{"type":"string","description":"Username for the user, it should respect the hub rules: No consecutive dashes, No digit-only, Does not start or end with a dash, Only dashes, letters or numbers, Not 24 chars hex string","required":true}}},"example":{"active":true,"emails":[],"externalId":"","name":{},"schemas":[],"userName":""}}}}}},"/api/organizations/{name}/service-accounts":{"get":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts"},"summary":"List service accounts","description":"List all service accounts for the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts"},"summary":"Create service account","description":"Create a new service account for the organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"Optional description of what this service account is used for"},"name":{"type":"string","description":"Display name for the service account","required":true}}},"example":{"description":"","name":""}}}}}},"/api/organizations/{name}/service-accounts/{serviceAccountId}":{"delete":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}"},"summary":"Delete service account","description":"Delete a service account and all its tokens. This action cannot be undone. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}"},"summary":"Get service account","description":"Retrieve a single service account and its access token metadata. Token secrets are never returned. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens":{"post":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens"},"summary":"Create service-account token","description":"Create a new access token for a service account. Store the token securely - it cannot be retrieved later. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"Display name for the token"},"endpointPatterns":{"type":"array","description":"Inference endpoint name patterns (wildcards allowed, e.g. `gpt2-*`) restricting the token's org-wide Inference Endpoint permissions to matching endpoints. Empty means all endpoints.","items":{"type":"string"}},"permissions":{"type":"array","description":"Org-wide permissions for this token","items":{"type":"string"}},"repoIds":{"type":"array","description":"Repositories to grant `repoPermissions` on. Can be repositories owned by the organization or any public repository. These override the org-wide permissions.","items":{"type":"string"}},"repoPermissions":{"type":"array","description":"Permissions granted on the selected `repoIds`.","items":{"type":"string"}},"skipNetworkSecurity":{"type":"boolean","description":"Exempt this token from the org's Network Security enforcement (IP allowlist and content access policy). Enterprise Plus only, and requires the `org.networkSecurity.write` permission.","enum":[true,false]}}},"example":{"displayName":"API Token","endpointPatterns":[],"permissions":[],"repoIds":[],"repoPermissions":[],"skipNetworkSecurity":""}}}}}},"/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}":{"delete":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}},{"name":"tokenId","in":"path","description":"token Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}"},"summary":"Delete service-account token","description":"Delete an access token from a service account. This action cannot be undone. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}},{"name":"tokenId","in":"path","description":"token Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}"},"summary":"Update service-account token","description":"Update the name and/or permissions of an existing service account token. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"displayName":{"type":"string","description":"New display name for the token"},"endpointPatterns":{"type":"array","description":"Inference endpoint name patterns (wildcards allowed, e.g. `gpt2-*`) restricting the token's org-wide Inference Endpoint permissions to matching endpoints. Empty means all endpoints.","items":{"type":"string"}},"permissions":{"type":"array","description":"Org-wide permissions for this token","items":{"type":"string"}},"repoIds":{"type":"array","description":"Repositories to grant `repoPermissions` on. Can be repositories owned by the organization or any public repository. These override the org-wide permissions.","items":{"type":"string"}},"repoPermissions":{"type":"array","description":"Permissions granted on the selected `repoIds`.","items":{"type":"string"}},"skipNetworkSecurity":{"type":"boolean","description":"Exempt this token from the org's Network Security enforcement (IP allowlist and content access policy). Enterprise Plus only, and requires the `org.networkSecurity.write` permission.","enum":[true,false]}}},"example":{"displayName":"","endpointPatterns":[],"permissions":[],"repoIds":[],"repoPermissions":[],"skipNetworkSecurity":""}}}}}},"/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}/rotate":{"post":{"tags":["Service Accounts"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"serviceAccountId","in":"path","description":"service Account Id","required":true,"schema":{"type":"string","example":""}},{"name":"tokenId","in":"path","description":"token Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/service-accounts/{serviceAccountId}/tokens/{tokenId}/rotate"},"summary":"Rotate service-account token","description":"Invalidate an existing token and generate a new one with the same permissions. The old token will stop working immediately. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/organizations/{name}/settings/network-security":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/network-security"},"summary":"Get network security settings","description":"Get the network security settings for an organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"patch":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/network-security"},"summary":"Update network security","description":"Update the network security settings for an organization. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowedContents":{"type":"array","description":"allowed Contents","items":{"type":"object","properties":{"resource":{"type":"object","description":"resource","required":true},"scope":{"type":"string","description":"scope","required":true}}}},"blockedContents":{"type":"array","description":"blocked Contents","items":{"type":"object","properties":{"resource":{"type":"object","description":"resource","required":true},"scope":{"type":"string","description":"scope","required":true}}}},"enforceAuth":{"type":"boolean","description":"enforce Auth","enum":[true,false]},"enforceIpRestriction":{"type":"boolean","description":"enforce Ip Restriction","enum":[true,false]},"highRateLimits":{"type":"boolean","description":"high Rate Limits","enum":[true,false]},"ipRanges":{"type":"array","description":"ip Ranges","items":{"type":"string"}},"keepReposMetadataVisible":{"type":"boolean","description":"keep Repos Metadata Visible","enum":[true,false]}}},"example":{"allowedContents":[],"blockedContents":[],"enforceAuth":"","enforceIpRestriction":"","highRateLimits":"","ipRanges":[],"keepReposMetadataVisible":""}}}}}},"/api/organizations/{name}/settings/repositories":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"Filter by repository type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dataset","model","space","bucket","kernel"]}}},{"name":"direction","in":"query","description":"Sort direction (default: desc)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"Max number of repositories to return","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter repositories by name (case-insensitive substring match)","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sort field (default: storage)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["storage","updatedAt"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/repositories"},"summary":"List organization repositories","description":"List organization repositories Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/settings/sso/credentials":{"put":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/sso/credentials"},"summary":"Rotate SSO credentials","description":"Update SSO credentials of the organization's SSO configuration. SSO stays enabled and does not need to be re-tested, so rotation causes no downtime. Requires a paid plan. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Request body","properties":{}}}},"example":{"body":{}}}}}}},"/api/organizations/{name}/settings/tokens":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Pagination cursor from the `Link` header","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"Filter on `owner:`, `role:`, `status:` and `token:` (last 4 characters), negatable with `-`. Pass `status:all` to include revoked tokens.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/tokens"},"summary":"List member access tokens","description":"List the access tokens of the organization's members. Team or Enterprise only. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/organizations/{name}/settings/tokens/{tokenId}/revoke":{"post":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}},{"name":"tokenId","in":"path","description":"token Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/settings/tokens/{tokenId}/revoke"},"summary":"Revoke member token","description":"An org admin can revoke a token's access to the org. The token itself isn't deleted, it still works outside the org. The token id is the one displayed in the org token settings page or through the tokens listing API endpoint. Enterprise only. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/organizations/{name}/socials":{"get":{"tags":["Organizations"],"parameters":[{"name":"name","in":"path","description":"name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/organizations/{name}/socials"},"summary":"Get social handles","description":"Get an organization's social media handles Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/papers":{"get":{"tags":["Papers"],"parameters":[{"name":"cursor","in":"query","description":"Pagination cursor","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers"},"summary":"List papers","description":"List arXiv papers sorted by published date Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/papers/index":{"post":{"tags":["Papers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/index"},"summary":"Index a paper","description":"Index a paper from arXiv by its ID. If the paper is already indexed, only its authors can re-index it. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"arxivId":{"type":"string","description":"The arXiv ID of the paper to index (e.g. 2301.00001)","required":true}}},"example":{"arxivId":""}}}}}},"/api/papers/search":{"get":{"tags":["Papers"],"parameters":[{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"q","in":"query","description":"q","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/search"},"summary":"Search papers","description":"Perform a hybrid semantic / full-text-search on papers Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/papers/{paperId}":{"get":{"tags":["Papers"],"parameters":[{"name":"paperId","in":"path","description":"paper Id","required":true,"schema":{"type":"string","example":""}},{"name":"field","in":"query","description":"field","required":false,"schema":{"type":"object","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/{paperId}"},"summary":"Get a paper","description":"Get a paper Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/papers/{paperId}/comment":{"post":{"tags":["Discussions"],"parameters":[{"name":"paperId","in":"path","description":"paper Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/{paperId}/comment"},"summary":"Create a new comment (Discussions POST) — POST /api/papers/{paperId}/comment","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/papers/{paperId}/comment/{commentId}/reply":{"post":{"tags":["Discussions"],"parameters":[{"name":"commentId","in":"path","description":"comment Id","required":true,"schema":{"type":"string","example":""}},{"name":"paperId","in":"path","description":"paper Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/{paperId}/comment/{commentId}/reply"},"summary":"Create a new comment (Discussions POST) — POST /api/papers/{paperId}/comment/{commentId}/reply","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/papers/{paperId}/links":{"post":{"tags":["Papers"],"parameters":[{"name":"paperId","in":"path","description":"paper Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/papers/{paperId}/links"},"summary":"Update paper links","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"githubRepo":{"type":"object","description":"github Repo","properties":{}},"organizationId":{"type":"object","description":"organization Id","properties":{}},"projectPage":{"type":"object","description":"project Page","properties":{}}}},"example":{"githubRepo":{},"organizationId":{},"projectPage":{}}}}}}},"/api/posts/{username}/{postSlug}":{"delete":{"tags":["Discussions"],"parameters":[{"name":"postSlug","in":"path","description":"post Slug","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/posts/{username}/{postSlug}"},"summary":"Delete a discussion","description":"Delete a discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/posts/{username}/{postSlug}/comment":{"post":{"tags":["Discussions"],"parameters":[{"name":"postSlug","in":"path","description":"post Slug","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/posts/{username}/{postSlug}/comment"},"summary":"Create a new comment (Discussions POST) — POST /api/posts/{username}/{postSlug}/comment","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/posts/{username}/{postSlug}/comment/{commentId}/reply":{"post":{"tags":["Discussions"],"parameters":[{"name":"commentId","in":"path","description":"comment Id","required":true,"schema":{"type":"string","example":""}},{"name":"postSlug","in":"path","description":"post Slug","required":true,"schema":{"type":"string","example":""}},{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/posts/{username}/{postSlug}/comment/{commentId}/reply"},"summary":"Create a new comment (Discussions POST) — POST /api/posts/{username}/{postSlug}/comment/{commentId}/reply","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/quicksearch":{"get":{"tags":["Repo Search"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"object","example":""}},{"name":"discussionCollectionName","in":"query","description":"discussion Collection Name","required":false,"schema":{"type":"string","example":""}},{"name":"discussionId","in":"query","description":"discussion Id","required":false,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Array of excluded resources: spaces/repo, models/repo, datasets/repo, papers/paperId, collections/collectionId, users/username, orgs/orgName, buckets/bucketName, kernels/repo","required":false,"schema":{"type":"array","example":""}},{"name":"includeInvitees","in":"query","description":"include Invitees","required":false,"schema":{"type":"object","example":""}},{"name":"lang","in":"query","description":"lang","required":false,"schema":{"type":"object","example":""}},{"name":"library","in":"query","description":"library","required":false,"schema":{"type":"object","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"object","example":""}},{"name":"namespace","in":"query","description":"Namespace to filter by","required":false,"schema":{"type":"string","example":""}},{"name":"orgsFilter","in":"query","description":"orgs Filter","required":false,"schema":{"type":"object","example":""}},{"name":"pipelines","in":"query","description":"Comma-separated or array of pipeline types","required":false,"schema":{"type":"object","example":""}},{"name":"q","in":"query","description":"q","required":false,"schema":{"type":"string","example":""}},{"name":"repoName","in":"query","description":"repo Name","required":false,"schema":{"type":"string","example":""}},{"name":"repoType","in":"query","description":"repo Type","required":false,"schema":{"type":"object","example":""}},{"name":"reposFilter","in":"query","description":"repos Filter","required":false,"schema":{"type":"object","example":""}},{"name":"spacesTags","in":"query","description":"spaces Tags","required":false,"schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/quicksearch"},"summary":"Quick search","description":"Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Repo Search"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"object","example":""}},{"name":"discussionCollectionName","in":"query","description":"discussion Collection Name","required":false,"schema":{"type":"string","example":""}},{"name":"discussionId","in":"query","description":"discussion Id","required":false,"schema":{"type":"string","example":""}},{"name":"exclude","in":"query","description":"Array of excluded resources: spaces/repo, models/repo, datasets/repo, papers/paperId, collections/collectionId, users/username, orgs/orgName, buckets/bucketName, kernels/repo","required":false,"schema":{"type":"array","example":""}},{"name":"includeInvitees","in":"query","description":"include Invitees","required":false,"schema":{"type":"object","example":""}},{"name":"lang","in":"query","description":"lang","required":false,"schema":{"type":"object","example":""}},{"name":"library","in":"query","description":"library","required":false,"schema":{"type":"object","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"object","example":""}},{"name":"namespace","in":"query","description":"Namespace to filter by","required":false,"schema":{"type":"string","example":""}},{"name":"orgsFilter","in":"query","description":"orgs Filter","required":false,"schema":{"type":"object","example":""}},{"name":"pipelines","in":"query","description":"Comma-separated or array of pipeline types","required":false,"schema":{"type":"object","example":""}},{"name":"q","in":"query","description":"q","required":false,"schema":{"type":"string","example":""}},{"name":"repoName","in":"query","description":"repo Name","required":false,"schema":{"type":"string","example":""}},{"name":"repoType","in":"query","description":"repo Type","required":false,"schema":{"type":"object","example":""}},{"name":"reposFilter","in":"query","description":"repos Filter","required":false,"schema":{"type":"object","example":""}},{"name":"spacesTags","in":"query","description":"spaces Tags","required":false,"schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/quicksearch"},"summary":"Quick search (Repo Search POST)","description":"Quick search for models, datasets, spaces, orgs, users, papers, collections, and buckets Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"object","description":"type","properties":{}},"discussionCollectionName":{"type":"string","description":"discussion Collection Name"},"discussionId":{"type":"string","description":"discussion Id"},"exclude":{"type":"array","description":"Array of excluded resources: spaces/repo, models/repo, datasets/repo, papers/paperId, collections/collectionId, users/username, orgs/orgName, buckets/bucketName, kernels/repo","required":true,"items":{"type":"string"}},"includeInvitees":{"type":"object","description":"include Invitees","properties":{}},"lang":{"type":"object","description":"lang","properties":{}},"library":{"type":"object","description":"library","properties":{}},"limit":{"type":"object","description":"limit","properties":{}},"namespace":{"type":"string","description":"Namespace to filter by"},"orgsFilter":{"type":"object","description":"orgs Filter","properties":{}},"pipelines":{"type":"object","description":"Comma-separated or array of pipeline types","properties":{}},"q":{"type":"string","description":"q"},"repoName":{"type":"string","description":"repo Name"},"repoType":{"type":"object","description":"repo Type","properties":{}},"reposFilter":{"type":"object","description":"repos Filter","properties":{}},"spacesTags":{"type":"array","description":"spaces Tags","items":{"type":"string"}}}},"example":{"type":{},"discussionCollectionName":"","discussionId":"","exclude":[],"includeInvitees":{},"lang":{},"library":{},"limit":{},"namespace":"","orgsFilter":{},"pipelines":{},"q":"","repoName":"","repoType":{},"reposFilter":{},"spacesTags":[]}}}}}},"/api/registry/token":{"get":{"tags":["Container"],"parameters":[{"name":"scope","in":"query","description":"Docker Distribution scope(s), e.g. `repository:org/img:push,pull`. May be repeated.","required":false,"schema":{"type":"object","example":""}},{"name":"service","in":"query","description":"Registry service identifier — placed in the JWT `aud` claim.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/registry/token"},"summary":"Registry token","description":"Mints a short-lived EdDSA JWT for the HuggingFace container registry, verifiable via the JWK at `/api/keys/jwt`. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/repos/create":{"post":{"tags":["Repos"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/repos/create"},"summary":"Create a new repository","description":"Create a new repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Request body","properties":{}}}},"example":{"body":{}}}}}}},"/api/repos/move":{"post":{"tags":["Repos"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/repos/move"},"summary":"Move repo","description":"Move or rename a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type","enum":["dataset","model","space","bucket","kernel"]},"fromRepo":{"type":"string","description":"from Repo","required":true},"toRepo":{"type":"string","description":"to Repo","required":true}}},"example":{"type":"model","fromRepo":"black-forest-labs/FLUX.1-dev","toRepo":""}}}}}},"/api/resolve-cache/datasets/{namespace}/{repo}/{rev}/{path}":{"get":{"tags":["Datasets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/resolve-cache/datasets/{namespace}/{repo}/{rev}/{path}"},"summary":"Resolve a file","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/resolve-cache/models/{namespace}/{repo}/{rev}/{path}":{"get":{"tags":["Models"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/resolve-cache/models/{namespace}/{repo}/{rev}/{path}"},"summary":"Resolve a file (Models GET)","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/resolve-cache/spaces/{namespace}/{repo}/{rev}/{path}":{"get":{"tags":["Spaces"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/resolve-cache/spaces/{namespace}/{repo}/{rev}/{path}"},"summary":"Resolve a file (Spaces GET)","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/scheduled-jobs/{namespace}":{"get":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"label","in":"query","description":"Filter scheduled jobs by label. Format: 'key=value' (e.g., 'environment=production').","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}"},"summary":"List scheduled jobs","description":"List scheduled jobs for an entity Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Jobs"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}"},"summary":"Create a scheduled job","description":"Create a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"concurrency":{"type":"boolean","description":"Whether multiple instances of this job can run concurrently","enum":[true,false]},"jobSpec":{"type":"object","description":"job Spec","required":true,"properties":{"arch":{"type":"string","description":"arch","enum":["amd64","arm64"]},"arguments":{"type":"array","description":"arguments"},"attempts":{"type":"number","description":"Max number of attempts to make. For example, if you set this to 3, the job will be retried up to 2 times if it fails."},"command":{"type":"array","description":"command"},"dockerImage":{"type":"string","description":"docker Image"},"environment":{"type":"object","description":"environment"},"expose":{"type":"object","description":"Ports to expose publicly through the jobs proxy. Each port is reachable at `https:// -- . `. Access requires a HF token with read access to the job's namespace, except for ports also listed in `portsPublic`."},"flavor":{"type":"string","description":"flavor","required":true,"enum":["cpu-basic","cpu-upgrade","cpu-performance","cpu-xl","sprx8","zero-a10g","t4-small","t4-medium","l4x1","l4x4","l40sx1","l40sx4","l40sx8","a10g-small","a10g-large","a10g-largex2","a10g-largex4","a100-large","a100x4","a100x8","h200","h200x2","h200x4","h200x8","rtx-pro-6000","rtx-pro-6000x2","rtx-pro-6000x4","rtx-pro-6000x8","inf2x6"]},"labels":{"type":"object","description":"Labels for the job as key-value pairs. Both keys and values must be max 100 characters and contain only alphanumeric characters, dots, dashes, and underscores."},"resourceGroupId":{"type":"string","description":"resource Group Id"},"secrets":{"type":"object","description":"secrets"},"spaceId":{"type":"string","description":"space Id"},"ssh":{"type":"object","description":"When `enabled`, the job's container is reachable over SSH at `ssh @ssh.hf.jobs`. Only the job's owner is allowed in, authenticated by an SSH public key registered on the Hub."},"timeoutSeconds":{"type":"object","description":"timeout Seconds"},"volumes":{"type":"array","description":"HuggingFace Buckets or Repos to mount as volumes in the job container."}}},"schedule":{"type":"string","description":"CRON schedule expression (e.g., '0 9 * * 1' for 9 AM every Monday).","required":true},"suspend":{"type":"boolean","description":"Whether the scheduled job is suspended (paused)","enum":[true,false]}}},"example":{"concurrency":"","jobSpec":{},"schedule":"","suspend":""}}}}}},"/api/scheduled-jobs/{namespace}/{jobId}":{"delete":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}"},"summary":"Delete a scheduled job","description":"Delete a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}"},"summary":"Get a scheduled job","description":"Get a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/scheduled-jobs/{namespace}/{jobId}/labels":{"put":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}/labels"},"summary":"Update scheduled job labels","description":"Replace user-provided labels on a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"labels":{"type":"object","description":"The new labels to set on the job. Replaces all existing labels.","required":true,"properties":{}}}},"example":{"labels":{}}}}}}},"/api/scheduled-jobs/{namespace}/{jobId}/resume":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}/resume"},"summary":"Resume a scheduled job","description":"Resume a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/scheduled-jobs/{namespace}/{jobId}/run":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}/run"},"summary":"Run job","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/scheduled-jobs/{namespace}/{jobId}/schedule":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}/schedule"},"summary":"Update job schedule","description":"Update job schedule Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"schedule":{"type":"string","description":"CRON schedule expression (e.g., '0 9 * * 1' for 9 AM every Monday).","required":true}}},"example":{"schedule":""}}}}}},"/api/scheduled-jobs/{namespace}/{jobId}/suspend":{"post":{"tags":["Jobs"],"parameters":[{"name":"jobId","in":"path","description":"job Id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/scheduled-jobs/{namespace}/{jobId}/suspend"},"summary":"Suspend a scheduled job","description":"Suspend a scheduled job Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/settings/billing/usage":{"get":{"tags":["Users"],"parameters":[{"name":"periodId","in":"query","description":"period Id","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/billing/usage"},"summary":"Get user usage","description":"Get user usage for a given period Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/billing/usage-by-inference-session":{"get":{"tags":["Users"],"parameters":[{"name":"endDate","in":"query","description":"end Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"start Date (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/billing/usage-by-inference-session"},"summary":"Get session inference usage (Users GET)","description":"Get user inference-provider usage broken down per session id Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/billing/usage-v2":{"get":{"tags":["Users"],"parameters":[{"name":"endDate","in":"query","description":"end Date","required":true,"schema":{"type":"number","example":""}},{"name":"startDate","in":"query","description":"start Date","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/billing/usage-v2"},"summary":"Get user usage (Users GET)","description":"Get user usage for a given period Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/billing/usage/jobs":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/billing/usage/jobs"},"summary":"Get jobs usage","description":"Get user Jobs usage for current subscription period Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/billing/usage/live":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/billing/usage/live"},"summary":"Stream usage (Users GET)","description":"Get live usage for user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/mcp":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/mcp"},"summary":"Get MCP tools","description":"Get the MCP tools for the current user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/metrics/live":{"get":{"tags":["Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/metrics/live"},"summary":"Stream metrics","description":"Get live usage and running jobs count for the logged-in user, over a single SSE connection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/notifications":{"patch":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/notifications"},"summary":"Update notification settings","description":"Update notification settings for the user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"notifications":{"type":"object","description":"notifications","required":true,"properties":{"announcements":{"type":"boolean","description":"announcements","enum":[true,false]},"api_inference_sunset":{"type":"boolean","description":"api inference sunset","enum":[true,false]},"arxiv_paper_activity":{"type":"boolean","description":"arxiv paper activity","enum":[true,false]},"daily_papers_digest":{"type":"boolean","description":"daily papers digest","enum":[true,false]},"discussions_participating":{"type":"boolean","description":"discussions participating","enum":[true,false]},"discussions_watched":{"type":"boolean","description":"discussions watched","enum":[true,false]},"gated_user_access_request":{"type":"boolean","description":"gated user access request","enum":[true,false]},"inference_endpoint_status":{"type":"boolean","description":"inference endpoint status","enum":[true,false]},"job_status":{"type":"boolean","description":"job status","enum":[true,false]},"launch_autonlp":{"type":"boolean","description":"launch autonlp","enum":[true,false]},"launch_prepaid_credits":{"type":"boolean","description":"launch prepaid credits","enum":[true,false]},"launch_spaces":{"type":"boolean","description":"launch spaces","enum":[true,false]},"launch_training_cluster":{"type":"boolean","description":"launch training cluster","enum":[true,false]},"locked_out":{"type":"boolean","description":"locked out","enum":[true,false]},"org_request":{"type":"boolean","description":"org request","enum":[true,false]},"org_suggestions":{"type":"boolean","description":"org suggestions","enum":[true,false]},"org_suggestions_to_create":{"type":"boolean","description":"org suggestions to create","enum":[true,false]},"org_verified_suggestions":{"type":"boolean","description":"org verified suggestions","enum":[true,false]},"posts_participating":{"type":"boolean","description":"posts participating","enum":[true,false]},"product_updates_after":{"type":"string","description":"product updates after (ISO 8601 date-time format)"},"repo_release":{"type":"boolean","description":"repo release","enum":[true,false]},"secret_detected":{"type":"boolean","description":"secret detected","enum":[true,false]},"user_follows":{"type":"boolean","description":"user follows","enum":[true,false]},"web_discussions_participating":{"type":"boolean","description":"web discussions participating","enum":[true,false]},"web_discussions_watched":{"type":"boolean","description":"web discussions watched","enum":[true,false]},"web_posts_participating":{"type":"boolean","description":"web posts participating","enum":[true,false]}}},"prepaidAmount":{"type":"string","description":"To be provided when enabling launch_prepaid_credits"}}},"example":{"notifications":{},"prepaidAmount":""}}}}}},"/api/settings/papers/claim":{"post":{"tags":["Papers"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/papers/claim"},"summary":"Claim paper authorship","description":"Claim paper authorship Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"claimAuthorId":{"type":"string","description":"Author entry on the paper being claimed.","required":true},"paperId":{"type":"string","description":"ArXiv paper identifier being claimed.","required":true},"targetUserId":{"type":"string","description":"HF user who should receive the claim."}}},"example":{"claimAuthorId":"","paperId":"","targetUserId":""}}}}}},"/api/settings/repositories":{"get":{"tags":["Users"],"parameters":[{"name":"type","in":"query","description":"Filter by repository type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["dataset","model","space","bucket","kernel"]}}},{"name":"direction","in":"query","description":"Sort direction (default: desc)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"Max number of repositories to return","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Filter repositories by name (case-insensitive substring match)","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Sort field (default: storage)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["storage","updatedAt"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/repositories"},"summary":"List user repositories","description":"List user repositories Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/settings/watch":{"patch":{"tags":["Notifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/watch"},"summary":"Update watch settings","description":"Update watch settings for the user. Get notified when discussions happen on your watched items. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"add":{"type":"array","description":"add","items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["org","user","repo"]},"id":{"type":"string","description":"id","required":true}}}},"delete":{"type":"array","description":"delete","items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["org","user","repo"]},"id":{"type":"string","description":"id","required":true}}}}}},"example":{"add":[],"delete":[]}}}}}},"/api/settings/webhooks":{"get":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks"},"summary":"List webhooks","description":"List webhooks Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks"},"summary":"Create webhook","description":"Create webhook Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domains":{"type":"array","description":"domains","required":true,"items":{"type":"string"}},"job":{"type":"object","description":"job","properties":{"arch":{"type":"string","description":"arch","enum":["amd64","arm64"]},"arguments":{"type":"array","description":"arguments"},"attempts":{"type":"number","description":"Max number of attempts to make. For example, if you set this to 3, the job will be retried up to 2 times if it fails."},"command":{"type":"array","description":"command"},"dockerImage":{"type":"string","description":"docker Image"},"environment":{"type":"object","description":"environment"},"expose":{"type":"object","description":"Ports to expose publicly through the jobs proxy. Each port is reachable at `https:// -- . `. Access requires a HF token with read access to the job's namespace, except for ports also listed in `portsPublic`."},"flavor":{"type":"string","description":"flavor","required":true,"enum":["cpu-basic","cpu-upgrade","cpu-performance","cpu-xl","sprx8","zero-a10g","t4-small","t4-medium","l4x1","l4x4","l40sx1","l40sx4","l40sx8","a10g-small","a10g-large","a10g-largex2","a10g-largex4","a100-large","a100x4","a100x8","h200","h200x2","h200x4","h200x8","rtx-pro-6000","rtx-pro-6000x2","rtx-pro-6000x4","rtx-pro-6000x8","inf2x6"]},"labels":{"type":"object","description":"Labels for the job as key-value pairs. Both keys and values must be max 100 characters and contain only alphanumeric characters, dots, dashes, and underscores."},"resourceGroupId":{"type":"string","description":"resource Group Id"},"secrets":{"type":"object","description":"secrets"},"spaceId":{"type":"string","description":"space Id"},"ssh":{"type":"object","description":"When `enabled`, the job's container is reachable over SSH at `ssh @ssh.hf.jobs`. Only the job's owner is allowed in, authenticated by an SSH public key registered on the Hub."},"timeoutSeconds":{"type":"object","description":"timeout Seconds"},"volumes":{"type":"array","description":"HuggingFace Buckets or Repos to mount as volumes in the job container."}}},"jobSourceId":{"type":"string","description":"job Source Id"},"secret":{"type":"string","description":"secret"},"url":{"type":"string","description":"url"},"watched":{"type":"array","description":"watched","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","bucket","kernel","user","org"]},"name":{"type":"string","description":"name","required":true}}}}}},"example":{"domains":[],"job":{},"jobSourceId":"","secret":"","url":"","watched":[]}}}}}},"/api/settings/webhooks/{webhookId}":{"delete":{"tags":["Webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks/{webhookId}"},"summary":"Delete webhook","description":"Delete webhook Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks/{webhookId}"},"summary":"Get webhook","description":"Get webhook Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[{"name":"webhookId","in":"path","description":"webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks/{webhookId}"},"summary":"Update webhook","description":"Update webhook Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domains":{"type":"array","description":"domains","required":true,"items":{"type":"string"}},"job":{"type":"object","description":"job","properties":{"arch":{"type":"string","description":"arch","enum":["amd64","arm64"]},"arguments":{"type":"array","description":"arguments"},"attempts":{"type":"number","description":"Max number of attempts to make. For example, if you set this to 3, the job will be retried up to 2 times if it fails."},"command":{"type":"array","description":"command"},"dockerImage":{"type":"string","description":"docker Image"},"environment":{"type":"object","description":"environment"},"expose":{"type":"object","description":"Ports to expose publicly through the jobs proxy. Each port is reachable at `https:// -- . `. Access requires a HF token with read access to the job's namespace, except for ports also listed in `portsPublic`."},"flavor":{"type":"string","description":"flavor","required":true,"enum":["cpu-basic","cpu-upgrade","cpu-performance","cpu-xl","sprx8","zero-a10g","t4-small","t4-medium","l4x1","l4x4","l40sx1","l40sx4","l40sx8","a10g-small","a10g-large","a10g-largex2","a10g-largex4","a100-large","a100x4","a100x8","h200","h200x2","h200x4","h200x8","rtx-pro-6000","rtx-pro-6000x2","rtx-pro-6000x4","rtx-pro-6000x8","inf2x6"]},"labels":{"type":"object","description":"Labels for the job as key-value pairs. Both keys and values must be max 100 characters and contain only alphanumeric characters, dots, dashes, and underscores."},"resourceGroupId":{"type":"string","description":"resource Group Id"},"secrets":{"type":"object","description":"secrets"},"spaceId":{"type":"string","description":"space Id"},"ssh":{"type":"object","description":"When `enabled`, the job's container is reachable over SSH at `ssh @ssh.hf.jobs`. Only the job's owner is allowed in, authenticated by an SSH public key registered on the Hub."},"timeoutSeconds":{"type":"object","description":"timeout Seconds"},"volumes":{"type":"array","description":"HuggingFace Buckets or Repos to mount as volumes in the job container."}}},"jobSourceId":{"type":"string","description":"job Source Id"},"secret":{"type":"string","description":"secret"},"url":{"type":"string","description":"url"},"watched":{"type":"array","description":"watched","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","bucket","kernel","user","org"]},"name":{"type":"string","description":"name","required":true}}}}}},"example":{"domains":[],"job":{},"jobSourceId":"","secret":"","url":"","watched":[]}}}}}},"/api/settings/webhooks/{webhookId}/replay/{logId}":{"post":{"tags":["Webhooks"],"parameters":[{"name":"logId","in":"path","description":"log Id","required":true,"schema":{"type":"string","example":""}},{"name":"webhookId","in":"path","description":"webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks/{webhookId}/replay/{logId}"},"summary":"Replay webhook log","description":"Replay webhook log Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/settings/webhooks/{webhookId}/{action}":{"post":{"tags":["Webhooks"],"parameters":[{"name":"action","in":"path","description":"action","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["enable","disable"]}}},{"name":"webhookId","in":"path","description":"webhook Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/settings/webhooks/{webhookId}/{action}"},"summary":"Enable/disable webhook","description":"Enable/disable webhook Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/spaces/hardware":{"get":{"tags":["Spaces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/hardware"},"summary":"List space hardware","description":"Get available space hardware Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/templates":{"get":{"tags":["Spaces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/templates"},"summary":"List Space templates","description":"Returns the catalog of official Space templates. The `repoId` of a template can be passed as `template` when creating a Space through the create-repo endpoint. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/zero-gpu/quota":{"get":{"tags":["Spaces"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/zero-gpu/quota"},"summary":"Get ZeroGPU quota","description":"Get the authenticated user's current ZeroGPU quota usage and limits Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/branch/{rev}":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/branch/{rev}"},"summary":"Delete a branch (Spaces DELETE)","description":"Delete a branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/branch/{rev}"},"summary":"Create branch (Spaces POST)","description":"Create branch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emptyBranch":{"type":"boolean","description":"Create an empty branch","enum":[true,false]},"overwrite":{"type":"boolean","description":"Overwrite the branch if it already exists","enum":[true,false]},"startingPoint":{"type":"string","description":"The commit to start from"}}},"example":{"emptyBranch":"","overwrite":"","startingPoint":""}}}}}},"/api/spaces/{namespace}/{repo}/commit/{rev}":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"create_pr","in":"query","description":"Whether to create a pull request from the commit","required":false,"schema":{"type":"string","example":""}},{"name":"hot_reload","in":"query","description":"For Spaces, whether to try to hot reload the commit (only for single python files updates)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/commit/{rev}"},"summary":"Commit (Spaces POST)","description":"For legacy reason, we support both `application/json` and `application/x-ndjson` but we recommend using `application/x-ndjson` to create a commit. JSON-lines payload: ```json { \"key\": \"header\", \"value\": { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" } } { \"key\": \"file\", \"value\": { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } { \"key\": \"deletedEntry\", \"value\": { \"path\": \"string (REQUIRED)\" } } { \"key\": \"lfsFile\", \"value\": { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } } ``` JSON payload: ```json { \"summary\": \"string (REQUIRED)\", \"description\": \"string (OPTIONAL - defaults to empty string)\", \"parentCommit\": \"string (OPTIONAL - 40-character hex SHA)\" \"files\": [ { \"path\": \"string (REQUIRED)\", \"content\": \"string (OPTIONAL - required if oldPath not set)\", \"encoding\": \"utf-8 | base64 (OPTIONAL - defaults to utf-8)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ], \"deletedEntries\": [ { \"path\": \"string (REQUIRED)\" } ], \"lfsFiles\": [ { \"path\": \"string (REQUIRED - max 1000 chars)\", \"oid\": \"string (OPTIONAL - required if oldPath not set, 64 hex chars)\", \"algo\": \"sha256 (OPTIONAL - only sha256 supported)\", \"size\": \"number (OPTIONAL - required if oldPath is set)\", \"oldPath\": \"string (OPTIONAL - for move/rename operations)\" } ] } ``` Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/spaces/{namespace}/{repo}/commits/{rev}":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"expand","required":false,"schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/commits/{rev}"},"summary":"List commits (Spaces GET)","description":"List commits Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/compare/{compare}":{"get":{"tags":["Spaces"],"parameters":[{"name":"compare","in":"path","description":"compare","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"raw","in":"query","description":"raw","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/compare/{compare}"},"summary":"Get a compare rev (Spaces GET)","description":"Get a compare rev Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/events":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"session_uuid","in":"query","description":"session uuid","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/events"},"summary":"Stream events","description":"Get status updates for a specific Space in a streaming fashion, with SSE protocol Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/jwt":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"billing_details","in":"query","description":"billing details","required":false,"schema":{"type":"string","example":""}},{"name":"encrypted","in":"query","description":"encrypted","required":false,"schema":{"type":"string","example":""}},{"name":"expiration","in":"query","description":"Requested expiration datetime, capped at the default (10 minutes with write, 24 hours for spaces, 1 hour otherwise). Use expires_in instead. (ISO 8601 date-time format)","required":false,"schema":{"type":"string","example":""}},{"name":"expires_in","in":"query","description":"Requested lifetime in seconds, capped at the default (600s with write, 86400s for spaces, 3600s otherwise)","required":false,"schema":{"type":"number","example":""}},{"name":"include_pro_status","in":"query","description":"Use billing_details instead.","required":false,"schema":{"type":"string","example":""}},{"name":"inference_api","in":"query","description":"inference api","required":false,"schema":{"type":"string","example":""}},{"name":"write","in":"query","description":"write","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/jwt"},"summary":"Generate JWT (Spaces GET)","description":"Generate a JWT token for accessing a repository. Supports optional write access for spaces in dev mode, custom expiration, and encryption. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/lfs-files":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"direction","in":"query","description":"direction","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["asc","desc"]}}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["size","pushedAt"]}}},{"name":"xet","in":"query","description":"xet","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/lfs-files"},"summary":"List Large files (Spaces GET)","description":"List Xet/LFS files for a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/lfs-files/batch":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/lfs-files/batch"},"summary":"Delete Large files (Spaces POST)","description":"Delete Xet/LFS files in batch Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"deletions":{"type":"object","description":"deletions","required":true,"properties":{"rewriteHistory":{"type":"boolean","description":"rewrite History","enum":[true,false]},"sha":{"type":"array","description":"sha","required":true}}}}},"example":{"deletions":{}}}}}}},"/api/spaces/{namespace}/{repo}/lfs-files/duplicate":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/lfs-files/duplicate"},"summary":"Duplicate xet files (Spaces POST)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"filename":{"type":"string","description":"filename"},"sha256":{"type":"string","description":"sha256","required":true},"xetHash":{"type":"string","description":"xet Hash","required":true}}}},"target":{"type":"object","description":"target","required":true,"properties":{"type":{"type":"string","description":"type","required":true,"enum":["dataset","model","space","kernel"]},"name":{"type":"string","description":"name","required":true}}}}},"example":{"files":[],"target":{}}}}}}},"/api/spaces/{namespace}/{repo}/lfs-files/{sha}":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"sha","in":"path","description":"sha","required":true,"schema":{"type":"string","example":""}},{"name":"rewriteHistory","in":"query","description":"rewrite History","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/lfs-files/{sha}"},"summary":"Delete Large file (Spaces DELETE)","description":"Delete a Xet/LFS file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/spaces/{namespace}/{repo}/logs/{logType}":{"get":{"tags":["Spaces"],"parameters":[{"name":"logType","in":"path","description":"log Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["build","run"]}}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"tail","in":"query","description":"Maximum number of lines to return from the logs.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/logs/{logType}"},"summary":"Stream logs","description":"Get logs for a specific Space in a streaming fashion, with SSE protocol Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/metrics":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/metrics"},"summary":"Stream metrics (Spaces GET)","description":"Get live metrics for a specific Space in a streaming fashion, with SSE protocol, such as current Zero-GPU usage Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/notebook/{rev}/{path}":{"get":{"tags":["Spaces"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/notebook/{rev}/{path}"},"summary":"Get notebook URL (Spaces GET)","description":"Get a jupyter notebook URL for the requested file Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/paths-info/{rev}":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/paths-info/{rev}"},"summary":"List paths info (Spaces POST)","description":"List paths info Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"expand":{"type":"object","description":"Expand the response with the last commit and security file status","required":true,"properties":{}},"paths":{"type":"object","description":"paths","required":true,"properties":{}}}},"example":{"expand":{},"paths":{}}}}}}},"/api/spaces/{namespace}/{repo}/preupload/{rev}":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/preupload/{rev}"},"summary":"Check upload method (Spaces POST)","description":"Check if a file should be uploaded through the Large File mechanism or directly. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"files":{"type":"array","description":"files","required":true,"items":{"type":"object","properties":{"path":{"type":"string","description":"path","required":true},"sample":{"type":"string","description":"sample","required":true},"size":{"type":"number","description":"size","required":true}}}},"gitAttributes":{"type":"string","description":"Provide this parameter if you plan to modify `.gitattributes` yourself at the same time as uploading LFS files. Note that this is not needed if you solely rely on automatic LFS detection from HF: the commit endpoint will automatically edit the `.gitattributes` file to track the files passed to its `lfsFiles` param."},"gitIgnore":{"type":"string","description":"Content of the .gitignore file for the revision. Optional, otherwise takes the existing content of `.gitignore` for the revision."}}},"example":{"files":[],"gitAttributes":"","gitIgnore":""}}}}}},"/api/spaces/{namespace}/{repo}/refs":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"include_prs","in":"query","description":"include prs","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/refs"},"summary":"List references (Spaces GET)","description":"List references Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/resource-group":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/resource-group"},"summary":"Get resource group (Spaces GET)","description":"Get resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/resource-group"},"summary":"Add resource group (Spaces POST)","description":"Add the repository to a resource group Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"resourceGroupId":{"type":"object","description":"The resource group to add the repository to, if null, the repository will be removed from the resource group","required":true,"properties":{}}}},"example":{"resourceGroupId":{}}}}}}},"/api/spaces/{namespace}/{repo}/scan":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/scan"},"summary":"Get security status (Spaces GET)","description":"Get the security status of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/secrets":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/secrets"},"summary":"Delete secret","description":"Delete Spaces's secret Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"key","required":true}}},"example":{"key":""}}}}},"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/secrets"},"summary":"List secrets","description":"List a Space's secret keys. Values are never returned. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/secrets"},"summary":"Upsert secret","description":"Upsert Spaces's secret Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"key":{"type":"string","description":"key","required":true},"value":{"type":"string","description":"value"}}},"example":{"description":"","key":"","value":""}}}}}},"/api/spaces/{namespace}/{repo}/settings":{"put":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/settings"},"summary":"Update repo settings (Spaces PUT)","description":"Update the settings of a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"discussionsDisabled":{"type":"boolean","description":"discussions Disabled","enum":[true,false]},"discussionsSorting":{"type":"string","description":"discussions Sorting","enum":["recently-created","trending","reactions"]},"gated":{"type":"object","description":"gated","properties":{}},"gatedNotificationsEmail":{"type":"string","description":"gated Notifications Email"},"gatedNotificationsMode":{"type":"string","description":"gated Notifications Mode","enum":["bulk","real-time"]},"orgMembersGated":{"type":"boolean","description":"If true, members of the owning org (except admins) must also go through the gated access-request flow.","enum":[true,false]},"private":{"type":"boolean","description":"private","enum":[true,false]},"visibility":{"type":"string","description":"Repository visibility. `protected` is only supported for Spaces.","enum":["private","public","protected"]}}},"example":{"discussionsDisabled":"","discussionsSorting":"","gated":{},"gatedNotificationsEmail":"","gatedNotificationsMode":"","orgMembersGated":"","private":"","visibility":""}}}}}},"/api/spaces/{namespace}/{repo}/super-squash/{rev}":{"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/super-squash/{rev}"},"summary":"Squash ref (Spaces POST)","description":"Squash all commits in the current ref into a single commit with the given message. Action is irreversible. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"}}},"example":{"message":""}}}}}},"/api/spaces/{namespace}/{repo}/tag/{rev}":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/tag/{rev}"},"summary":"Delete a tag (Spaces DELETE)","description":"Delete a tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/tag/{rev}"},"summary":"Create tag (Spaces POST)","description":"Create tag Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"message":{"type":"string","description":"message"},"tag":{"type":"string","description":"tag","required":true}}},"example":{"message":"","tag":""}}}}}},"/api/spaces/{namespace}/{repo}/tree/{rev}/{path}":{"get":{"tags":["Spaces"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"cursor","required":false,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"If true, returns returns associated commit data for each entry and security scanner metadata.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"1.000 by default, 100 by default for expand=true","required":false,"schema":{"type":"number","example":""}},{"name":"recursive","in":"query","description":"If true, returns the tree recursively.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/tree/{rev}/{path}"},"summary":"List folder content (Spaces GET)","description":"List the content of a repository tree, with pagination support. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/treesize/{rev}/{path}":{"get":{"tags":["Spaces"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/treesize/{rev}/{path}"},"summary":"Get folder size (Spaces GET)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/variables":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/variables"},"summary":"Delete variable","description":"Delete Spaces's variable Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"key":{"type":"string","description":"key","required":true}}},"example":{"key":""}}}}},"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/variables"},"summary":"List variables","description":"List a Space's variables with their values. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/variables"},"summary":"Upsert variable","description":"Upsert Spaces's variable Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description"},"key":{"type":"string","description":"key","required":true},"value":{"type":"string","description":"value"}}},"example":{"description":"","key":"","value":""}}}}}},"/api/spaces/{namespace}/{repo}/volumes":{"delete":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/volumes"},"summary":"Delete Space volumes","description":"Delete Space volumes Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"put":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/volumes"},"summary":"Set Space volumes","description":"Set Space volumes Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"volumes":{"type":"array","description":"volumes","required":true,"items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["bucket","model","dataset","space"]},"path":{"type":"string","description":"Subfolder prefix inside the bucket/repo to mount, e.g. 'path/to/dir'"},"mountPath":{"type":"string","description":"Mount path inside the container, e.g. '/data'","required":true},"readOnly":{"type":"boolean","description":"Read-only mount (true for repos, false default for buckets)","enum":[true,false]},"revision":{"type":"string","description":"Git revision (only for repos, defaults to 'main')"},"source":{"type":"string","description":"Source identifier, e.g. 'username/my-bucket' or 'username/my-model'","required":true}}}}}},"example":{"volumes":[]}}}}}},"/api/spaces/{namespace}/{repo}/xet-read-token/{rev}":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/xet-read-token/{rev}"},"summary":"Xet read token (Spaces GET)","description":"Get a read short-lived access token for XET Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/spaces/{namespace}/{repo}/xet-write-token/{rev}":{"get":{"tags":["Spaces"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/spaces/{namespace}/{repo}/xet-write-token/{rev}"},"summary":"Xet write token (Spaces GET)","description":"Get a write short-lived access token for XET upload Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/trending":{"get":{"tags":["Models"],"parameters":[{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","dataset","model","space"]}}},{"name":"limit","in":"query","description":"limit","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/trending"},"summary":"Get trending","description":"Get the trending repositories Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/avatar":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}},{"name":"redirect","in":"query","description":"Redirect to the avatar url instead of returning it","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/avatar"},"summary":"Retrieve user avatar","description":"This endpoint returns a JSON with the avatar URL for the user. If called with the `Sec-Fetch-Dest: image` header, it instead redirects to the avatar URL Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/billing/usage/live":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/billing/usage/live"},"summary":"Stream usage (Users GET) — GET /api/users/{username}/billing/usage/live","description":"Get live usage for user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/followers":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Cursor for pagination","required":false,"schema":{"type":"string","example":""}},{"name":"expand","in":"query","description":"expand","required":false,"schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"Max number of followers to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/followers"},"summary":"List user followers","description":"List user followers Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/following":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Cursor for pagination","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/following"},"summary":"List followed users","description":"List followed users Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/following/orgs":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Cursor for pagination","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/following/orgs"},"summary":"List followed organizations","description":"List followed organizations Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/likes":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}},{"name":"cursor","in":"query","description":"Cursor for pagination. Always check to see if more results, a page can be empty or not filled.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Max number of likes to return","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/likes"},"summary":"List user likes","description":"List public repos liked by a user Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/overview":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/overview"},"summary":"User overview","description":"User overview Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/users/{username}/socials":{"get":{"tags":["Users"],"parameters":[{"name":"username","in":"path","description":"username","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/users/{username}/socials"},"summary":"Get social handles (Users GET)","description":"Get a user's social media handles Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/whoami-v2":{"get":{"tags":["Auth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/whoami-v2"},"summary":"Get user info","description":"Get information about the user and auth method used Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/{repoType}/{namespace}/{repo}/discussions":{"get":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}},{"name":"type","in":"query","description":"type","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","discussion","pull_request"]}}},{"name":"author","in":"query","description":"author","required":false,"schema":{"type":"string","example":""}},{"name":"p","in":"query","description":"p","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"search","required":false,"schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"sort","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["recently-created","trending","reactions"]}}},{"name":"status","in":"query","description":"status","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["all","open","closed"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions"},"summary":"List discussions","description":"Get discussions for a repo Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions"},"summary":"Create a new discussion","description":"Create a new discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"description","required":true},"pullRequest":{"type":"boolean","description":"pull Request","enum":[true,false]},"title":{"type":"string","description":"title","required":true}}},"example":{"description":"","pullRequest":"","title":""}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}":{"delete":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}"},"summary":"Delete a discussion (Discussions DELETE)","description":"Delete a discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"get":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}"},"summary":"Get discussion details","description":"Get discussion details Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/comment":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/comment"},"summary":"Create a new comment (Discussions POST) — POST /api/{repoType}/{namespace}/{repo}/discussions/{num}/comment","description":"Create a new comment Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment","required":true}}},"example":{"comment":""}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/merge":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/merge"},"summary":"Merge a pull request","description":"Merge a pull request Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment"}}},"example":{"comment":""}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/pin":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/pin"},"summary":"Pin a discussion","description":"Pin a discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"pinned":{"type":"boolean","description":"pinned","required":true,"enum":[true,false]}}},"example":{"pinned":""}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/ref":{"delete":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/ref"},"summary":"Delete PR ref","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/status":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/status"},"summary":"Change status","description":"Change the status of a discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"comment":{"type":"string","description":"comment"},"status":{"type":"string","description":"status","required":true,"enum":["open","closed"]}}},"example":{"comment":"","status":""}}}}}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/storage":{"get":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/storage"},"summary":"PR storage estimate","description":"Estimates the LFS storage used by a PR that could be freed if the ref is deleted. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/{repoType}/{namespace}/{repo}/discussions/{num}/title":{"post":{"tags":["Discussions"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"num","in":"path","description":"num","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","spaces","datasets","kernels"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/discussions/{num}/title"},"summary":"Change title","description":"Change the title of a discussion Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"title":{"type":"string","description":"title","required":true}}},"example":{"title":""}}}}}},"/api/{repoType}/{namespace}/{repo}/duplicate":{"post":{"tags":["Repos"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["spaces"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/duplicate"},"summary":"Duplicate a repository","description":"Duplicate a repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"hardware":{"type":"string","description":"hardware","enum":["cpu-basic","cpu-upgrade","cpu-performance","cpu-xl","sprx8","zero-a10g","t4-small","t4-medium","l4x1","l4x4","l40sx1","l40sx4","l40sx8","a10g-small","a10g-large","a10g-largex2","a10g-largex4","a100-large","a100x4","a100x8","h200","h200x2","h200x4","h200x8","rtx-pro-6000","rtx-pro-6000x2","rtx-pro-6000x4","rtx-pro-6000x8","inf2x6",""]},"private":{"type":"boolean","description":"private","enum":[true,false]},"repository":{"type":"string","description":"repository","required":true},"resourceGroupId":{"type":"object","description":"resource Group Id","properties":{}},"secrets":{"type":"array","description":"secrets","items":{"type":"object","properties":{"description":{"type":"string","description":"description"},"key":{"type":"string","description":"key","required":true},"value":{"type":"string","description":"value","required":true}}}},"sleepTimeSeconds":{"type":"object","description":"sleep Time Seconds","properties":{}},"variables":{"type":"array","description":"variables","items":{"type":"object","properties":{"description":{"type":"string","description":"description"},"key":{"type":"string","description":"key","required":true},"value":{"type":"string","description":"value","required":true}}}},"visibility":{"type":"string","description":"visibility","enum":["private","public","protected"]},"volumes":{"type":"array","description":"HuggingFace Buckets or Repos to mount as volumes in the duplicated Space.","items":{"type":"object","properties":{"type":{"type":"string","description":"type","required":true,"enum":["bucket","model","dataset","space"]},"path":{"type":"string","description":"Subfolder prefix inside the bucket/repo to mount, e.g. 'path/to/dir'"},"mountPath":{"type":"string","description":"Mount path inside the container, e.g. '/data'","required":true},"readOnly":{"type":"boolean","description":"Read-only mount (true for repos, false default for buckets)","enum":[true,false]},"revision":{"type":"string","description":"Git revision (only for repos, defaults to 'main')"},"source":{"type":"string","description":"Source identifier, e.g. 'username/my-bucket' or 'username/my-model'","required":true}}}}}},"example":{"hardware":"","private":"","repository":"","resourceGroupId":{},"secrets":[],"sleepTimeSeconds":{},"variables":[],"visibility":"","volumes":[]}}}}}},"/api/{repoType}/{namespace}/{repo}/duplicate/status":{"get":{"tags":["Repos"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["models","datasets","spaces"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/duplicate/status"},"summary":"Duplication status","description":"Duplication status Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/api/{repoType}/{namespace}/{repo}/sql-console/embed":{"post":{"tags":["SQL Console"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["datasets"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/sql-console/embed"},"summary":"Create embed","description":"Create SQL Console embed Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"private":{"type":"boolean","description":"private","enum":[true,false]},"sql":{"type":"string","description":"sql","required":true},"title":{"type":"string","description":"title","required":true},"views":{"type":"array","description":"views","required":true,"items":{"type":"object","properties":{"displayName":{"type":"string","description":"display Name","required":true},"key":{"type":"string","description":"key","required":true},"viewName":{"type":"string","description":"view Name","required":true}}}}}},"example":{"private":"","sql":"","title":"","views":[]}}}}}},"/api/{repoType}/{namespace}/{repo}/sql-console/embed/{id}":{"delete":{"tags":["SQL Console"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["datasets"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/sql-console/embed/{id}"},"summary":"Delete embed","description":"Delete SQL Console embed Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"patch":{"tags":["SQL Console"],"parameters":[{"name":"id","in":"path","description":"id","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"repoType","in":"path","description":"repo Type","required":true,"schema":{"type":"string","example":"","items":{"type":"string","enum":["datasets"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/api/{repoType}/{namespace}/{repo}/sql-console/embed/{id}"},"summary":"Update embed","description":"Update SQL Console embed Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"private":{"type":"boolean","description":"private","enum":[true,false]},"sql":{"type":"string","description":"sql"},"title":{"type":"string","description":"title"}}},"example":{"private":"","sql":"","title":""}}}}}},"/buckets/{namespace}/{repo}/resolve/{path}":{"get":{"tags":["Buckets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"download","in":"query","description":"download","required":false,"schema":{"type":"string","example":""}},{"name":"noContentDisposition","in":"query","description":"no Content Disposition","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/buckets/{namespace}/{repo}/resolve/{path}"},"summary":"Get file metadata","description":"Returns file metadata including size, hash, and links to XET authentication Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/datasets/{namespace}/{repo}/ask-access":{"post":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/datasets/{namespace}/{repo}/ask-access"},"summary":"Request access","description":"Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information) Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Request body","properties":{}}}},"example":{"body":{}}}}}}},"/datasets/{namespace}/{repo}/resolve/{rev}/{path}":{"get":{"tags":["Datasets"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/datasets/{namespace}/{repo}/resolve/{rev}/{path}"},"summary":"Resolve a file (Datasets GET)","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/datasets/{namespace}/{repo}/user-access-report":{"get":{"tags":["Datasets"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/datasets/{namespace}/{repo}/user-access-report"},"summary":"Export access report","description":"Export a report of all access requests for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/oauth/device":{"post":{"tags":["OAuth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/oauth/device"},"summary":"Initiate device authorization","description":"Initiate device authorization Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_id":{"type":"string","description":"client id","required":true},"scope":{"type":"string","description":"scope"}}},"example":{"client_id":"","scope":""}}}}}},"/oauth/register":{"post":{"tags":["OAuth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/oauth/register"},"summary":"Register a new OAuth app","description":"Register a new OAuth app Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_name":{"type":"string","description":"client name"},"client_uri":{"type":"string","description":"client uri"},"contacts":{"type":"array","description":"contacts","items":{"type":"string"}},"logo_uri":{"type":"string","description":"logo uri"},"redirect_uris":{"type":"array","description":"redirect uris","items":{"type":"string"}},"scope":{"type":"string","description":"scope"},"software_id":{"type":"string","description":"software id"},"software_version":{"type":"string","description":"software version"},"token_endpoint_auth_method":{"type":"string","description":"token endpoint auth method","enum":["client_secret_basic","none","client_secret_post"]}}},"example":{"client_name":"","client_uri":"","contacts":[],"logo_uri":"","redirect_uris":[],"scope":"","software_id":"","software_version":"","token_endpoint_auth_method":""}}}}}},"/oauth/userinfo":{"get":{"tags":["OAuth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/oauth/userinfo"},"summary":"Get user info (OAuth GET)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]},"post":{"tags":["OAuth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/oauth/userinfo"},"summary":"Get user info (OAuth POST)","description":"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. Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/spaces/{namespace}/{repo}/resolve/{rev}/{path}":{"get":{"tags":["Spaces"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/spaces/{namespace}/{repo}/resolve/{rev}/{path}"},"summary":"Resolve a file (Spaces GET) — GET /spaces/{namespace}/{repo}/resolve/{rev}/{path}","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/{namespace}/{repo}/ask-access":{"post":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/{namespace}/{repo}/ask-access"},"summary":"Request access (Models POST)","description":"Request access to a gated repository. The fields requested by repository card metadata (https://huggingface.co/docs/hub/en/models-gated#customize-requested-information) Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"object","description":"Request body","properties":{}}}},"example":{"body":{}}}}}}},"/{namespace}/{repo}/resolve/{rev}/{path}":{"get":{"tags":["Models"],"parameters":[{"name":"path","in":"path","description":"Wildcard path parameter","required":true,"schema":{"type":"string","example":""}},{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}},{"name":"rev","in":"path","description":"rev","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/{namespace}/{repo}/resolve/{rev}/{path}"},"summary":"Resolve a file (Models GET) — GET /{namespace}/{repo}/resolve/{rev}/{path}","description":"This endpoint requires to follow redirection Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/{namespace}/{repo}/user-access-report":{"get":{"tags":["Models"],"parameters":[{"name":"namespace","in":"path","description":"namespace","required":true,"schema":{"type":"string","example":""}},{"name":"repo","in":"path","description":"repo","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/hub/api","api_endpoint":"https://huggingface.co/{namespace}/{repo}/user-access-report"},"summary":"Export access report (Models GET)","description":"Export a report of all access requests for a gated repository Source: official Hugging Face Hub API reference https://huggingface.co/docs/hub/api (OpenAPI spec https://huggingface.co/.well-known/openapi.json).","security":[{"bearerAuth":[]}]}},"/v1/chat/completions":{"post":{"tags":["Chat"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/inference-providers/index","api_endpoint":"https://router.huggingface.co/v1/chat/completions"},"summary":"Create chat completion (Inference Providers)","description":"OpenAI-compatible chat completion routed by Hugging Face to an Inference Provider. Model id accepts a policy or provider suffix: :fastest (default), :cheapest, :preferred, or a provider name (e.g. openai/gpt-oss-120b:groq). Same HF token as the Hub API, Authorization Bearer. Source: official Inference Providers docs.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"max_tokens":{"type":"number","description":"Maximum number of tokens to generate"},"messages":{"type":"array","description":"Array of message objects with role (system/user/assistant) and content","required":true,"items":{"type":"object","properties":{"content":{"type":"string","description":"Content of the message","required":true},"role":{"type":"string","description":"Role of the message sender","required":true}}}},"model":{"type":"string","description":"Model id with optional policy/provider suffix (:fastest default, :cheapest, :preferred, or provider name)","required":true},"stream":{"type":"boolean","description":"Stream response chunks via SSE"},"temperature":{"type":"number","description":"Sampling temperature"},"top_p":{"type":"number","description":"Nucleus sampling parameter"}}},"example":{"max_tokens":512,"messages":[{"content":"How many G in huggingface?","role":"user"}],"model":"openai/gpt-oss-120b","stream":"","temperature":0.7,"top_p":0.9}}}}}},"/v1/models":{"get":{"tags":["Models"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://huggingface.co/docs/inference-providers/index","api_endpoint":"https://router.huggingface.co/v1/models"},"summary":"List inference models","description":"List models available across Inference Providers, including per-provider pricing, context length, latency and throughput when available. Same HF token as the Hub API.","security":[{"bearerAuth":[]}]}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}