huggingface.dataset

stable Standard

Hugging Face dataset metadata.

GET /v1/huggingface/dataset

What you get#

One Huggingface record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

What it costs#

Standard · 1 credit for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`owner`	string	yes	(required)	Hub user or organisation name	max 96 chars; must match `[A-Za-z0-9][A-Za-z0-9._-]{0,95}`; trimmed
`name`	string	yes	(required)	Repository name	max 96 chars; must match `[A-Za-z0-9][A-Za-z0-9._-]{0,95}`; trimmed

Request#

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

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real Huggingface response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": {
    "entity": {
      "id": "rajpurkar/squad",
      "stats": {
        "downloads": 260507
      },
      "updatedAt": "2024-03-04T13:54:37Z",
      "createdAt": "2022-03-02T23:29:22Z",
      "tags": [
        "task_categories:question-answering",
        "task_ids:extractive-qa",
        "annotations_creators:crowdsourced"
      ],
      "description": "Dataset Card for SQuAD Dataset Summary Stanford Question Answering Dataset (SQuAD) is a reading comprehension dataset, consisting of questions posed by crowdworkers on a set of Wikipedia articles, where the answer to every question is a segment of text, or span, from the corresponding reading passage, or the question might be unanswerable. SQuAD 1.1 contains 100,000+ question-answer pairs on 500+ articles. Supported Tasks and Leaderboards Question… See the full description on the dataset page: https://huggingface.co/datasets/rajpurkar/squad."
    },
    "author": {
      "username": "rajpurkar"
    },
    "engagement": {
      "likes": 1117
    }
  },
  "metadata": {
    "platform": "huggingface",
    "endpoint": "dataset",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`id`	`entity.id`	-
`author`	`author.username`	-
`downloads`	`entity.stats.downloads`	`toNumber`
`likes`	`engagement.likes`	`toNumber`
`lastModified`	`entity.updatedAt`	`toIsoDate`
`createdAt`	`entity.createdAt`	`toIsoDate`
`tags`	`entity.tags`	-
`description`	`entity.description`	`stripHtml`

Caching and freshness#

Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
Between 1 hour and 1 day the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 3 days more (marked stale).
A "not found" is remembered for 5 minutes and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	That record does not exist. Free; do not retry.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).