Docs
View as Markdown

huggingface.datasets

stable Advanced

Search Hugging Face datasets.

GET /v1/huggingface/datasets

What you get#

A list of Huggingface results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

  • Advanced · 5 credits 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#

NameTypeRequiredDefaultWhat it isConstraints
qstringyes(required)Search querymax 200 chars; trimmed, repeated spaces collapsed

Request#

curl "https://api.onekey.dev/v1/huggingface/datasets?q=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
      }
    },
    {
      "entity": {
        "id": "rajpurkar/squad_v2",
        "stats": {
          "downloads": 81226
        },
        "updatedAt": "2024-03-04T13:55:27Z",
        "createdAt": "2022-03-02T23:29:22Z",
        "tags": [
          "task_categories:question-answering",
          "task_ids:open-domain-qa",
          "task_ids:extractive-qa"
        ],
        "description": "Dataset Card for SQuAD 2.0 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 2.0 combines the 100,000 questions in SQuAD1.1 with over 50,000 unanswerable questions written adversarially by crowdworkers… See the full description on the dataset page: https://huggingface.co/datasets/rajpurkar/squad_v2."
      },
      "author": {
        "username": "rajpurkar"
      },
      "engagement": {
        "likes": 263
      }
    }
  ],
  "metadata": {
    "platform": "huggingface",
    "endpoint": "datasets",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "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 pathOnekey fieldTransform
identity.id-
authorauthor.username-
downloadsentity.stats.downloadstoNumber
likesengagement.likestoNumber
lastModifiedentity.updatedAttoIsoDate
createdAtentity.createdAttoIsoDate
tagsentity.tags-
descriptionentity.descriptionstripHtml

Caching and freshness#

  • Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
  • Between 2 minutes and 15 minutes 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 1 hour more (marked stale).
  • A "not found" is remembered for 1 minute and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundUnknown endpoint path.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).