# Hugging Face on Onekey

> 15 endpoints for Hugging Face (15 stable, 0 beta), 1 to 5 credits each. Category: AI & search. One key, one JSON shape.

Base URL: https://api.onekey.dev
Auth: header `x-api-key: <key>`. Call shape: `GET /v1/{platform}/{endpoint}?{params}`.
Every response is `{success, data, metadata, error}`; check `success` first. Cost is in `metadata.credits_charged`. Free when served from cache (0.2 credit for a cached response over 100 KB). Failed and not-found calls are refunded.
Status: stable = verified against the live source; beta = not yet verified, fields may be missing.

Page: https://onekey.dev/platforms/huggingface
Reference (Markdown): https://onekey.dev/docs/api/huggingface.md
All docs: https://onekey.dev/llms.txt

## Canonical fields returned

Unified-schema fields (same names on every platform), with how many of the 15 mapped Hugging Face endpoints return each:

- `engagement.likes` (integer): 13
- `author.username` (string): 12
- `entity.createdAt` (ISO 8601 date): 9
- `entity.id` (string): 9
- `entity.stats.downloads` (integer): 9
- `entity.tags` (list of strings): 9
- `entity.updatedAt` (ISO 8601 date): 9
- `content.text` (string): 6
- `content.id` (string): 4
- `content.title` (string): 4
- `content.createdAt` (ISO 8601 date): 3
- `entity.description` (string): 3
- `author.avatarUrl` (URL): 2
- `author.displayName` (string): 2
- `author.followers` (integer): 2
- `author.verified` (boolean): 2
- `engagement.comments` (integer): 2
- `media.thumbnailUrl` (URL): 2
- `package.repositoryUrl` (URL): 2
- `author.createdAt` (ISO 8601 date): 1
- `author.following` (integer): 1
- `content.updatedAt` (ISO 8601 date): 1
- `engagement.bookmarks` (integer): 1
- plus 6 platform-specific fields under `ext.`

## Endpoints

### huggingface.collections

Search Hugging Face collections.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/collections?q=llama` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `content.id`, `content.title`, `content.text`, `content.updatedAt`, `engagement.likes`, `author.username`
- Reference: https://onekey.dev/docs/api/huggingface/collections.md

### huggingface.daily_papers

Hugging Face Daily Papers feed.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/daily_papers` with header `x-api-key: YOUR_API_KEY`
- Parameters: none
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `package.repositoryUrl`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/huggingface/daily_papers.md

### huggingface.dataset

Hugging Face dataset metadata.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/dataset?owner=rajpurkar&name=squad` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): Hub user or organisation name
  - `name` (string, required): Repository name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `entity.description`
- Reference: https://onekey.dev/docs/api/huggingface/dataset.md

### huggingface.datasets

Search Hugging Face datasets.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/datasets?q=squad` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `entity.description`
- Reference: https://onekey.dev/docs/api/huggingface/datasets.md

### huggingface.datasets_by_author

Datasets published by a Hugging Face user or organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/datasets_by_author?author=google` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `author` (string, required): Hub user or organisation name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `entity.description`
- Reference: https://onekey.dev/docs/api/huggingface/datasets_by_author.md

### huggingface.model

Hugging Face model metadata.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/model?owner=google-bert&name=bert-base-uncased` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): Hub user or organisation name
  - `name` (string, required): Repository name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.task`, `ext.library`
- Reference: https://onekey.dev/docs/api/huggingface/model.md

### huggingface.models

Search Hugging Face models.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/models?q=llama` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.task`, `ext.library`
- Reference: https://onekey.dev/docs/api/huggingface/models.md

### huggingface.models_by_author

Models published by a Hugging Face user or organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/models_by_author?author=google` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `author` (string, required): Hub user or organisation name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.task`, `ext.library`
- Reference: https://onekey.dev/docs/api/huggingface/models_by_author.md

### huggingface.organization

Hugging Face organisation profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/organization?name=google` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Hub user or organisation name
- Fields returned: `author.username`, `author.displayName`, `author.followers`, `author.avatarUrl`, `content.text`, `author.verified`, `ext.models`, `ext.datasets`, `ext.spaces`
- Reference: https://onekey.dev/docs/api/huggingface/organization.md

### huggingface.paper

A paper indexed on Hugging Face Papers.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/paper?id=1706.03762` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `id` (string, required): Paper (arXiv) id, e.g. 1706.03762
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `package.repositoryUrl`, `engagement.bookmarks`
- Reference: https://onekey.dev/docs/api/huggingface/paper.md

### huggingface.papers_search

Search Hugging Face Papers.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/papers_search?q=attention` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `content.id`, `content.title`, `content.text`, `content.createdAt`, `engagement.likes`, `engagement.comments`, `media.thumbnailUrl`
- Reference: https://onekey.dev/docs/api/huggingface/papers_search.md

### huggingface.space

Hugging Face space metadata.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/space?owner=gradio&name=hello_world` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `owner` (string, required): Hub user or organisation name
  - `name` (string, required): Repository name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.sdk`
- Reference: https://onekey.dev/docs/api/huggingface/space.md

### huggingface.spaces

Search Hugging Face spaces.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/spaces?q=chat` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `q` (string, required): Search query
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.sdk`
- Reference: https://onekey.dev/docs/api/huggingface/spaces.md

### huggingface.spaces_by_author

Spaces published by a Hugging Face user or organisation.
- Price: 5 credits per fresh call. Status: stable. Returns: a list.
- Request: `GET https://api.onekey.dev/v1/huggingface/spaces_by_author?author=google` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `author` (string, required): Hub user or organisation name
- Fields returned: `entity.id`, `author.username`, `entity.stats.downloads`, `engagement.likes`, `entity.updatedAt`, `entity.createdAt`, `entity.tags`, `ext.sdk`
- Reference: https://onekey.dev/docs/api/huggingface/spaces_by_author.md

### huggingface.user

Hugging Face user profile.
- Price: 1 credit per fresh call. Status: stable. Returns: one record.
- Request: `GET https://api.onekey.dev/v1/huggingface/user?name=julien-c` with header `x-api-key: YOUR_API_KEY`
- Parameters:
  - `name` (string, required): Hub user or organisation name
- Fields returned: `author.username`, `author.displayName`, `author.followers`, `author.following`, `author.avatarUrl`, `content.text`, `author.verified`, `author.createdAt`, `ext.models`, `ext.datasets`, `ext.spaces`
- Reference: https://onekey.dev/docs/api/huggingface/user.md

## Sample request

```bash
curl "https://api.onekey.dev/v1/huggingface/dataset?owner=rajpurkar&name=squad" \
  -H "x-api-key: YOUR_API_KEY"
```