Connector Details
Type
Virtual machines, Single VM , BYOL
Runs on
Google Compute Engine
Last Update
24 October, 2024
Category
Financial services
Hugging Face Connector
Overview
The Hugging Face Connector enables seamless integration with the Hugging Face Hub, providing access to machine learning models, datasets, applications (Spaces), and related metadata without requiring authentication for public resources. This connector is ideal for building AI-powered applications, data analysis pipelines, model evaluation platforms, and community-driven tools.
Integration Overview
This document provides a detailed guide for each integration action point, its purpose, configuration, and workflow support using the Hugging Face connector.
Supported Integration Action Points
- DELETE_/api/collections/{namespace}/{slug}-{id}
- DELETE_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
- DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}
- DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
- DELETE_/api/repos/delete
- GET_/api/{repo_type}/{namespace}/{repo}/resource-group
- GET_/api/arxiv/{arxiv_id}/repos
- GET_/api/collections
- GET_/api/collections/{namespace}/{slug}-{id}
- GET_/api/daily_papers
- GET_/api/datasets
- GET_/api/datasets-tags-by-type
- GET_/api/datasets/{repo_id}
- GET_/api/datasets/{repo_id}/croissant
- GET_/api/datasets/{repo_id}/parquet
- GET_/api/datasets/{repo_id}/parquet/{subset}
- GET_/api/datasets/{repo_id}/parquet/{subset}/{split}
- GET_/api/datasets/{repo_id}/parquet/{subset}/{split}/{n}.parquet
- GET_/api/datasets/{repo_id}/revision/{revision}
- GET_/api/models
- GET_/api/models-tags-by-type
- GET_/api/models/{repo_id}
- GET_/api/models/{repo_id}/revision/{revision}
- GET_/api/organizations/{name}/resource-groups
- GET_/api/organizations/{name}/resource-groups/{resourceGroupId}
- GET_/api/organizations/{organization_name}/members
- GET_/api/papers/{arxiv_id}
- GET_/api/spaces
- GET_/api/spaces/{repo_id}
- GET_/api/spaces/{repo_id}/revision/{revision}
- GET_/api/whoami-v2
- PATCH_/api/collections/{namespace}/{slug}-{id}
- PATCH_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
- PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}
- PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
- POST_/api/{repo_type}/{namespace}/{repo}/resource-group
- POST_/api/collections
- POST_/api/collections/{namespace}/{slug}-{id}/item
- POST_/api/organizations/{name}/resource-groups
- POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/settings
- POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/users
- POST_/api/repos/create
- POST_/api/repos/move
- PUT_/api/repos/{repo_type}/{repo_id}/settings
Detailed Integration Documentation
DELETE_/api/collections/{namespace}/{slug}-{id}
Action
DELETE_/api/collections/{namespace}/{slug}-{id}
Purpose
Deletes a specific collection from the Hugging Face Hub.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful:Returns a JSON object with:
message: Confirmation message (string, e.g., “Collection deleted”). - Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute DELETE_/api/collections/huggingface/my-collection-123 with Accept=application/json.
3. Process the response to confirm collection deletion in a management dashboard.
DELETE_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
Action
DELETE_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
Purpose
Removes an item from a specific collection.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- item_id: Unique item identifier (string, e.g., model/bert-base-uncased).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful:Returns a JSON object with:
message: Confirmation message (string, e.g., “Item removed”). - Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute DELETE_/api/collections/huggingface/my-collection-123/items/model/bert-base-uncased with Accept=application/json.
3. Process the response to update the collection view.
DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}
Action
DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}
Purpose
Deletes a resource group from an organization.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Unique resource group identifier (string, e.g., rg123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
message: Confirmation message (string, e.g., “Resource group deleted”). - Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute DELETE_/api/organizations/huggingface/resource-groups/rg123 with Accept=application/json.
3. Process the response to update organization settings.
DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
Action
DELETE_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
Purpose
Removes a user from a resource group.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Unique resource group identifier (string, e.g., rg123).
- username: Username of the user to remove (string, e.g., user1).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful:Returns a JSON object with:
message: Confirmation message (string, e.g., “User removed”). - Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute DELETE_/api/organizations/huggingface/resource-groups/rg123/users/user1 with Accept=application/json.
3. Process the response to update resource group membership.
DELETE_/api/repos/delete
Action
DELETE_/api/repos/delete
Purpose
Deletes a repository from the Hugging Face Hub.
Parameters
- Required:
- name: Repository name (string, e.g., bert-base-uncased).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- type: Repository type (string, default: model, enum: model, dataset, space).
- organization: Organization owning the repository (string, e.g., huggingface).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
message: Confirmation message (string, e.g., “Repository deleted”). - Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute DELETE_/api/repos/delete with name=bert-base-uncased, type=model, Accept=application/json.
3. Process the response to confirm repository deletion.
GET_/api/{repo_type}/{namespace}/{repo}/resource-group
Action
GET_/api/{repo_type}/{namespace}/{repo}/resource-group
Purpose
Retrieves a repository’s resource group details.
Parameters
- Required:
- repo_type: Repository type (string, enum: models, spaces, datasets).
- namespace: Namespace of the repository (string, e.g., huggingface).
- repo: Repository name (string, e.g., bert-base-uncased).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- name: Resource group name (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute GET_/api/models/huggingface/bert-base-uncased/resource-group with Accept=application/json.
3. Process the response to display resource group details.
GET_/api/arxiv/{arxiv_id}/repos
Action
GET_/api/arxiv/{arxiv_id}/repos
Purpose
Retrieves repositories linked to a paper.
Parameters
- Required:
- arxiv_id: arXiv paper identifier (string, e.g., 2205.12345).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON array of repository objects, each with:
- id: Repository identifier (string).
- type: Repository type (string, enum: model, dataset, space).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/arxiv/2205.12345/repos with Accept=application/json.
3. Process the response to display linked repositories in a research dashboard.
GET_/api/collections
Action
GET_/api/collections
Purpose
Retrieves a list of collections from the Hub.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- owner: Filter by owner (string, e.g., huggingface).
- item: Filter by item ID (string, e.g., model/bert-base-uncased).
- sort: Sort property (string, enum: lastModified, trending, upvotes).
- limit: Number of collections to fetch (integer, 1-100).
- q: Search query (string, e.g., nlp).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON array of collection objects, each with:
- id: Collection identifier (string).
- title: Collection title (string).
- namespace: Collection namespace (string).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/collections with q=nlp, limit=10, Accept=application/json.
3. Process the response to display collections in a curated list.
GET_/api/collections/{namespace}/{slug}-{id}
Action
GET_/api/collections/{namespace}/{slug}-{id}
Purpose
Retrieves details of a specific collection.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- id: Collection identifier (string).
- title: Collection title (string).
- namespace: Collection namespace (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/collections/huggingface/my-collection-123 with Accept=application/json.
3. Process the response to display collection details.
GET_/api/daily_papers
Action
GET_/api/daily_papers
Purpose
Retrieves daily curated papers.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- date: Specific date (string, format: YYYY-MM-DD, e.g., 2025-05-31).
- month: Specific month (string, format: YYYY-MM, e.g., 2025-05).
- week: Specific week (string, e.g., 2025-W22).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of paper objects, each with:
- arxiv_id: Paper identifier (string).
- title: Paper title (string).
- Failure: Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/daily_papers with date=2025-05-31, Accept=application/json.
3. Process the response to display papers in a research feed.
GET_/api/datasets
Action
GET_/api/datasets
Purpose
Retrieves a list of datasets from the Hub.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- search: Filter by name or username (string, e.g., squad).
- author: Filter by author (string, e.g., huggingface).
- filter: Filter by tags (string, e.g., task_categories:text-classification).
- sort: Sort property (string, enum: downloads, author, lastModified).
- direction: Sort direction (string, enum: -1, 1).
- limit: Number of datasets to fetch (integer, minimum: 1).
- full: Fetch all data (boolean).
- config: Fetch repo config (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of dataset objects, each with:
- id: Dataset identifier (string).
- name: Dataset name (string).
- author: Dataset author (string).
- tags: Dataset tags (array).
- Failure: Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets with search=squad, limit=10, Accept=application/json.
3. Process the response to display datasets in a data explorer.
GET_/api/datasets-tags-by-type
Action
GET_/api/datasets-tags-by-type
Purpose
Retrieves all dataset tags.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of tag strings (e.g., [“question-answering”, “text-classification”]).
- Failure: Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets-tags-by-type with Accept=application/json.
3. Process the response to populate dataset filtering options.
GET_/api/datasets/{repo_id}
Action
GET_/api/datasets/{repo_id}
Purpose
Retrieves details of a specific dataset.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- full: Fetch all data (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON object with:
- id: Dataset identifier (string).
- name: Dataset name (string).
- author: Dataset author (string).
- tags: Dataset tags (array).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad with full=true, Accept=application/json.
3. Process the response to display dataset metadata.
GET_/api/datasets/{repo_id}/croissant
Action
GET_/api/datasets/{repo_id}/croissant
Purpose
Retrieves Croissant metadata for a dataset.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON object with:
- metadata: Croissant metadata (object).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/croissant with Accept=application/json.
3. Process the response to integrate Croissant metadata.
GET_/api/datasets/{repo_id}/parquet
Action
GET_/api/datasets/{repo_id}/parquet
Purpose
Retrieves a list of parquet files for a dataset.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of file objects, each with:
- file: Parquet file path (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/parquet with Accept=application/json.
3. Process the response to manage parquet files.
GET_/api/datasets/{repo_id}/parquet/{subset}
Action
GET_/api/datasets/{repo_id}/parquet/{subset}
Purpose
Retrieves parquet files for a dataset subset.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- subset: Dataset subset (string, e.g., default).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of file objects, each with:
- file: Parquet file path (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/parquet/default with Accept=application/json.
3. Process the response to manage subset parquet files.
GET_/api/datasets/{repo_id}/parquet/{subset}/{split}
Action
GET_/api/datasets/{repo_id}/parquet/{subset}/{split}
Purpose
Retrieves parquet files for a dataset subset and split.
Parameters
- Required:
-
- repo_id: Dataset repository identifier (string, e.g., squad).
subset: Dataset subset (string, e.g., default).
- split: Dataset split (string, e.g., train).
- Accept: Header specifying response format (string, default: application/json).
-
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of file objects, each with:
- file: Parquet file path (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/parquet/default/train with Accept=application/json.
3. Process the response to manage split parquet files.
GET_/api/datasets/{repo_id}/parquet/{subset}/{split}/{n}.parquet
Action
GET_/api/datasets/{repo_id}/parquet/{subset}/{split}/{n}.parquet
Purpose
Retrieves a specific parquet shard for a dataset.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- subset: Dataset subset (string, e.g., default).
- split: Dataset split (string, e.g., train).
- n: Shard number (integer, minimum: 0).
- Accept: Header specifying response format (string, default: application/octet-stream).
- Optional:
- None.
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a binary parquet file.
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/parquet/default/train/0.parquet with Accept=application/octet-stream.
3. Process the response to download the parquet shard.
GET_/api/datasets/{repo_id}/revision/{revision}
Action
GET_/api/datasets/{repo_id}/revision/{revision}
Purpose
Retrieves details of a specific dataset revision.
Parameters
- Required:
- repo_id: Dataset repository identifier (string, e.g., squad).
- revision: Dataset revision (string, e.g., main).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- full: Fetch all data (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- id: Dataset identifier (string).
- name: Dataset name (string).
- revision: Revision identifier (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/datasets/squad/revision/main with full=true, Accept=application/json.
3. Process the response to display revision details.
GET_/api/models
Action
GET_/api/models
Purpose
Retrieves a list of models from the Hub.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- search: Filter by name or username (string, e.g., bert).
- author: Filter by author (string, e.g., huggingface).
- filter: Filter by tags (string, e.g., text-classification).
- sort: Sort property (string, enum: downloads, author, lastModified).
- direction: Sort direction (string, enum: -1, 1).
- limit: Number of models to fetch (integer, minimum: 1).
- full: Fetch all data (boolean).
- config: Fetch repo config (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of model objects, each with:
- id: Model identifier (string).
- name: Model name (string).
- author: Model author (string).
- tags: Model tags (array).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/models with search=bert, limit=10, Accept=application/json.
3. Process the response to display models in a selection dashboard.
GET_/api/models-tags-by-type
Action
GET_/api/models-tags-by-type
Purpose
Retrieves all model tags.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of tag strings (e.g., [“text-classification”, “nlp”]).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/models-tags-by-type with Accept=application/json.
3. Process the response to populate model filtering options.
GET_/api/models/{repo_id}
Action
GET_/api/models/{repo_id}
Purpose
Retrieves details of a specific model.
Parameters
- Required:
- repo_id: Model repository identifier (string, e.g., bert-base-uncased).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON object with:
- id: Model identifier (string).
- name: Model name (string).
- author: Model author (string).
- tags: Model tags (array).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/models/bert-base-uncased with Accept=application/json.
3. Process the response to display model metadata.
GET_/api/models/{repo_id}/revision/{revision}
Action
GET_/api/models/{repo_id}/revision/{revision}
Purpose
Retrieves details of a specific model revision.
Parameters
- Required:
- repo_id: Model repository identifier (string, e.g., bert-base-uncased).
- revision: Model revision (string, e.g., main).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON object with:
- id: Model identifier (string).
- name: Model name (string).
- revision: Revision identifier (string).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/models/bert-base-uncased/revision/main with Accept=application/json.
3. Process the response to display revision details.
GET_/api/organizations/{name}/resource-groups
Action
GET_/api/organizations/{name}/resource-groups
Purpose
Retrieves all resource groups in an organization.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful:Returns a JSON array of resource group objects, each with:
- id: Resource group identifier (string).
- name: Resource group name (string).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/organizations/huggingface/resource-groups with Accept=application/json.
3. Process the response to display resource groups.
GET_/api/organizations/{name}/resource-groups/{resourceGroupId}
Action
GET_/api/organizations/{name}/resource-groups/{resourceGroupId}
Purpose
Retrieves details of a specific resource group.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- name: Resource group name (string).
- description: Resource group description (string).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/organizations/huggingface/resource-groups/rg123 with Accept=application/json.
3. Process the response to display resource group details.
GET_/api/organizations/{organization_name}/members
Action
GET_/api/organizations/{organization_name}/members
Purpose
Retrieves members of an organization.
Parameters
- Required:
- organization_name: Organization name (string, e.g., huggingface).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON array of member objects, each with:
- username: Member username (string).
- role: Member role (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute GET_/api/organizations/huggingface/members with Accept=application/json.
3. Process the response to display organization members.
GET_/api/papers/{arxiv_id}
Action
GET_/api/papers/{arxiv_id}
Purpose
Retrieves metadata for a specific paper.
Parameters
- Required:
- arxiv_id: arXiv paper identifier (string, e.g., 2205.12345).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- arxiv_id: Paper identifier (string).
- title: Paper title (string).
- authors: List of authors (array).
- summary: Paper summary (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/papers/2205.12345 with Accept=application/json.
3. Process the response to display paper metadata.
GET_/api/spaces
Action
GET_/api/spaces
Purpose
Retrieves a list of Spaces from the Hub.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- search: Filter by name or username (string, e.g., gradio).
- author: Filter by author (string, e.g., huggingface).
- filter: Filter by tags (string, e.g., gradio).
- sort: Sort property (string, enum: downloads, author, lastModified).
- direction: Sort direction (string, enum: -1, 1).
- limit: Number of Spaces to fetch (integer, minimum: 1).
- full: Fetch all data (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON array of Space objects, each with:
- id: Space identifier (string).
- name: Space name (string).
- author: Space author (string).
- tags: Space tags (array).
- Failure:Returns error codes (400: Bad Request, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/spaces with search=gradio, limit=10, Accept=application/json.
3. Process the response to display Spaces in an application gallery.
GET_/api/spaces/{repo_id}
Action
GET_/api/spaces
Purpose
Retrieves details of a specific Space.
Parameters
- Required:
- repo_id: Space repository identifier (string, e.g., huggingface/demo).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- id: Space identifier (string).
- name: Space name (string).
- author: Space author (string).
- tags: Space tags (array).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/spaces/huggingface/demo with Accept=application/json.
3. Process the response to display Space metadata.
GET_/api/spaces/{repo_id}/revision/{revision}
Action
GET_/api/spaces/{repo_id}/revision/{revision}
Purpose
Retrieves details of a specific Space revision.
Parameters
- Required:
- repo_id: Space repository identifier (string, e.g., huggingface/demo).
- revision: Space revision (string, e.g., main).
- Accept: Header specifying response format (string, default: application/json).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co).
Output
- Successful: Returns a JSON object with:
- id: Space identifier (string).
- name: Space name (string).
- revision: Revision identifier (string).
- Failure:Returns error codes (400: Bad Request, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL.
2. Execute GET_/api/spaces/huggingface/demo/revision/main with Accept=application/json.
3. Process the response to display revision details.
GET_/api/whoami-v2
Action
GET_/api/whoami-v2
Purpose
Retrieves authenticated user information.
Parameters
- Required:
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- username: User username (string).
- organizations: List of user organizations (array).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute GET_/api/whoami-v2 with Accept=application/json.
3. Process the response to display user profile information.
PATCH_/api/collections/{namespace}/{slug}-{id}
Action
PATCH_/api/collections/{namespace}/{slug}-{id}
Purpose
Updates metadata of a specific collection.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- title: Updated collection title (string).
- description: Updated description (string).
- private: Privacy setting (boolean).
- position: Collection position (integer).
- theme: Collection theme (string).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Collection identifier (string).
- title: Updated collection title (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute PATCH_/api/collections/huggingface/my-collection-123 with body {title: “Updated Collection”}, Accept=application/json.
3. Process the response to update collection metadata.
PATCH_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
Action
PATCH_/api/collections/{namespace}/{slug}-{id}/items/{item_id}
Purpose
Updates an item’s note or position in a collection.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- item_id: Unique item identifier (string, e.g., model/bert-base-uncased).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- position: Item position (integer).
- note: Item note (string).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- item_id: Item identifier (string).
- note: Updated note (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute PATCH_/api/collections/huggingface/my-collection-123/items/model/bert-base-uncased with body {note: “Updated note”}, Accept=application/json.
3. Process the response to update the collection item.
PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}
Action
PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}
Purpose
Updates a resource group’s metadata.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- name: Updated resource group name (string).
- description: Updated description (string).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- name: Updated resource group name (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute PATCH_/api/organizations/huggingface/resource-groups/rg123 with body {name: “Updated RG”}, Accept=application/json.
3. Process the response to update resource group metadata.
PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
Action
PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}/users/{username}
Purpose
Updates a user’s role in a resource group.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- username: Username of the user (string, e.g., user1).
- role: Updated role (string, enum: admin, write, read).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- username: User username (string).
- role: Updated role (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute PATCH_/api/organizations/huggingface/resource-groups/rg123/users/user1 with body {role: “admin”}, Accept=application/json.
3. Process the response to update user roles.
POST_/api/{repo_type}/{namespace}/{repo}/resource-group
Action
POST_/api/{repo_type}/{namespace}/{repo}/resource-group
Purpose
Updates a repository’s resource group.
Parameters
- Required:
- repo_type: Repository type (string, enum: models, spaces, datasets).
- namespace: Namespace of the repository (string, e.g., huggingface).
- repo: Repository name (string, e.g., bert-base-uncased).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
- Successful: Returns a JSON object with:
- id: Repository identifier (string).
- resourceGroupId: Updated resource group identifier (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/models/huggingface/bert-base-uncased/resource-group with body {resourceGroupId: “rg123”}, Accept=application/json.
3. Process the response to update repository settings.
POST_/api/collections
Action
POST_/api/collections
Purpose
Creates a new collection on the Hub.
Parameters
- Required:
- title: Collection title (string, e.g., NLP Models).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- namespace: Collection namespace (string, e.g., huggingface).
- description: Collection description (string).
- item: Item to add (object, e.g., {type: “model”, id: “bert-base-uncased”}).
- private: Privacy setting (boolean).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Collection identifier (string).
- title: Collection title (string).
- Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/collections with body {title: “NLP Models”}, Accept=application/json.
3. Process the response to create a new collection.
POST_/api/collections/{namespace}/{slug}-{id}/item
Action
POST_/api/collections/{namespace}/{slug}-{id}/item
Purpose
Adds an item to a specific collection.
Parameters
- Required:
- namespace: Namespace of the collection (string, e.g., huggingface).
- slug: Slug of the collection (string, e.g., my-collection).
- id: Unique collection identifier (string, e.g., 123).
- item: Item to add (object, e.g., {type: “model”, id: “bert-base-uncased”}).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- note: Item note (string).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Collection identifier (string).
- item: Added item details (object).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/collections/huggingface/my-collection-123/item with body {item: {type: “model”, id: “bert-base-uncased”}}, Accept=application/json.
3. Process the response to update the collection.
POST_/api/organizations/{name}/resource-groups
Action
POST_/api/organizations/{name}/resource-groups
Purpose
Creates a new resource group in an organization.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- name: Resource group name (string, e.g., ResearchGroup).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- description: Resource group description (string).
- users: List of users (array, e.g., [{user: “user1”, role: “admin”}]).
- repos: List of repositories (array, e.g., [{type: “model”, name: “bert-base-uncased”}]).
- autoJoin: Auto-join settings (object, e.g., {enabled: true, role: “read”}).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- name: Resource group name (string).
- Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/organizations/huggingface/resource-groups with body {name: “ResearchGroup”}, Accept=application/json.
3. Process the response to create a new resource group.
POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/settings
Action
POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/settings
Purpose
Updates a resource group’s settings.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- autoJoin: Auto-join settings (object, e.g., {enabled: true, role: “read”}).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- autoJoin: Updated auto-join settings (object).
- Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/organizations/huggingface/resource-groups/rg123/settings with body {autoJoin: {enabled: true, role: “read”}}, Accept=application/json.
3. Process the response to update resource group settings.
POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/users
Action
POST_/api/organizations/{name}/resource-groups/{resourceGroupId}/users
Purpose
Adds users to a resource group.
Parameters
- Required:
- name: Organization name (string, e.g., huggingface).
- resourceGroupId: Resource group identifier (string, e.g., rg123).
- users: List of users (array, e.g., [{user: “user1”, role: “admin”}]).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- autoJoin: Auto-join settings (object, e.g., {enabled: true, role: “read”}).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Resource group identifier (string).
- users: List of added users (array).
- Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 404: Not Found, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/organizations/huggingface/resource-groups/rg123/users with body {users: [{user: “user1”, role: “admin”}]}, Accept=application/json.
3. Process the response to update resource group membership.
POST_/api/repos/create
Action
POST_/api/repos/create
Purpose
Creates a new repository on the Hub.
Parameters
- Required:
- name: Repository name (string, e.g., my-model).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- type: Repository type (string, default: model, enum: model, dataset, space).
- organization: Organization name (string, e.g., huggingface).
- private: Privacy setting (boolean).
- sdk: SDK for Spaces (string, enum: streamlit, gradio, docker, static).
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Repository identifier (string).
- name: Repository name (string).
- type: Repository type (string).
- Failure: Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/repos/create with body {name: “my-model”, type: “model”}, Accept=application/json.
3. Process the response to create a new repository.
POST_/api/repos/move
Action
POST_/api/repos/move
Purpose
Moves or renames a repository.
Parameters
- Required:
- fromRepo: Source repository name (string, e.g., old-model).
- toRepo: Target repository name (string, e.g., new-model).
- type: Repository type (string, enum: model, dataset, space).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Repository identifier (string).
- name: Updated repository name (string).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute POST_/api/repos/move with body {fromRepo: “old-model”, toRepo: “new-model”, type: “model”}, Accept=application/json.
3. Process the response to update repository details.
PUT_/api/repos/{repo_type}/{repo_id}/settings
Action
PUT_/api/repos/{repo_type}/{repo_id}/settings
Purpose
Updates a repository’s visibility settings.
Parameters
- Required:
- repo_type: Repository type (string, enum: model, dataset, space).
- repo_id: Repository identifier (string, e.g., bert-base-uncased).
- private: Privacy setting (boolean).
- Accept: Header specifying response format (string, default: application/json).
- Authorization: Bearer token for authentication (string).
- Optional:
- none
Configuration
Ensure the connector is configured with the base URL (https://huggingface.co) and a valid Bearer token.
Output
- Successful: Returns a JSON object with:
- id: Repository identifier (string).
- private: Updated privacy setting (boolean).
- Failure:Returns error codes (400: Bad Request, 401: Unauthorized, 500: Internal Server Error).
Workflow Example
1. Configure the API client with the base URL and Bearer token.
2. Execute PUT_/api/repos/model/bert-base-uncased/settings with body {private: true}, Accept=application/json.
2. Process the response to update repository visibility.
4. Example Workflow: AI-Powered Application Development
Resource and Collection Management
Create and manage collections using POST_/api/collections and PATCH_/api/collections/{namespace}/{slug}-{id}.
Repository Management
Create, move, or delete repositories using POST_/api/repos/create, POST_/api/repos/move, and DELETE_/api/repos/delete.
Dataset and Model Access
Fetch datasets and models using GET_/api/datasets and GET_/api/models for integration into AI pipelines.
Organization and Resource Groups
Manage organization resources using POST_/api/organizations/{name}/resource-groups and PATCH_/api/organizations/{name}/resource-groups/{resourceGroupId}.
Research Integration
Access papers and linked repositories using GET_/api/papers/{arxiv
Pricing
iSolution logo - white - transparent 250 px