/huggingface/datasets

POST /api/huggingface/datasets

Price: 1 credit

Get Hugging Face dataset details by repository id or URL

How to use it

Get full details of a Hugging Face dataset by repository id ('org/name') or dataset URL. Returns downloads, likes, tags, license/card data, description, files, used storage, and Papers with Code id.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• dataset string required — Dataset repository id ('org/name') or full dataset URL (examples: "stanfordnlp/imdb", "https://huggingface.co/datasets/HuggingFaceFW/fineweb"; minLength: 1)

Response

• @type string (default: "HuggingfaceDataset")
• id string required
• url string required
• author string nullable
• sha string nullable
• download_count integer nullable
• like_count integer nullable
• trending_score number nullable
• description string nullable
• tags array (default: [])
• gated union nullable
• is_private boolean (default: false)
• is_disabled boolean (default: false)
• created_at string nullable
• last_modified string nullable
• used_storage integer nullable
• paperswithcode_id string nullable
• card_data object nullable
• siblings array (default: [])
  • @type string (default: "HuggingfaceModelFile")
  • rfilename string required
  • size integer nullable
  • blob_id string nullable
  • lfs_size integer nullable

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — Dataset not found Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.