In this quickstart, you’ll learn how to use the Datasets Server’s REST API to:
Each feature is served through an endpoint summarized in the table below:
Endpoint | Method | Description | Query parameters |
---|---|---|---|
/valid | GET | Get the list of datasets hosted in the Hub and supported by the datasets server. | none |
/is-valid | GET | Check whether a specific dataset is valid. | dataset : name of the dataset |
/splits | GET | Get the list of configurations and splits of a dataset. | dataset : name of the dataset |
/first-rows | GET | Get the columns (with data type) and first rows of a dataset split. | - dataset : name of the dataset- config : name of the config- split : name of the split |
/parquet | GET | Get the list of parquet files of a dataset. | dataset : name of the datasett |
There is no installation or setup required to use Datasets Server.
Feel free to try out the API in Postman, ReDoc or RapidAPI. This quickstart will show you how to query the endpoints programmatically.
The base URL of the REST API is:
https://datasets-server.huggingface.co
For gated datasets, you’ll need to provide your user token in headers
of your query. Otherwise, you’ll get an error message to retry with authentication.
import requests
headers = {"Authorization": f"Bearer {API_TOKEN}"}
API_URL = "https://datasets-server.huggingface.co/is-valid?dataset=mozilla-foundation/common_voice_10_0"
def query():
response = requests.request("GET", API_URL, headers=headers)
return response.json()
data = query()
The /valid
endpoint returns a JSON list of datasets stored on the Hub that load without any errors:
import requests
API_URL = "https://datasets-server.huggingface.co/valid"
def query():
response = requests.request("GET", API_URL)
return response.json()
data = query()
To check whether a specific dataset is valid, for example, Rotten Tomatoes, use the /is-valid
endpoint instead:
import requests
API_URL = "https://datasets-server.huggingface.co/is-valid?dataset=rotten_tomatoes"
def query():
response = requests.request("GET", API_URL)
return response.json()
data = query()
The /splits
endpoint returns a JSON list of the splits in a dataset:
import requests
API_URL = "https://datasets-server.huggingface.co/splits?dataset=rotten_tomatoes"
def query():
response = requests.request("GET", API_URL)
return response.json()
data = query()
The /first-rows
endpoint returns a JSON list of the first 100 rows of a dataset. You should specify the dataset name, configuration name (you can find out the configuration name from the /splits
endpoint), and split name of the dataset you’d like to preview:
import requests
API_URL = "https://datasets-server.huggingface.co/first-rows?dataset=rotten_tomatoes&config=default&split=train"
def query():
response = requests.request("GET", API_URL)
return response.json()
data = query()
The datasets-server converts every dataset on the Hub to the parquet format. The /parquet
endpoint returns a JSON list of the parquet URLs for a dataset:
import requests
API_URL = "https://datasets-server.huggingface.co/parquet?dataset=rotten_tomatoes"
def query():
response = requests.request("GET", API_URL)
return response.json()
data = query()