Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hugging Face Files & Metadata API

Parquet files, size, statistics, and metadata

Hugging Face Files & Metadata API is one of 21 APIs that Hugging Face publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Files & Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a getting-started guide, rate-limit docs, and pricing.

This API exposes 4 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://datasets-server.huggingface.co.

4 operations 4 paths 4 schemas 4 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://api-inference.huggingface.co
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Hugging Face Files & Metadata API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (HF Token) (bearerAuth). By default, every request must be authenticated, though some operations may also be called without credentials.

  • bearerAuth — Optional Hugging Face API token. Required for private and gated datasets.

Paths & Operations 4

Across 4 paths, the API surfaces 4 operations — 4 GET. Each is listed below with its method, path, parameters, and response codes.

Files & Metadata 4

Parquet files, size, statistics, and metadata

GET
/parquet
List Parquet Files
getParquetFiles 1 param → 200404
GET
/size
Get Dataset Size
getDatasetSize 1 param → 200404
GET
/statistics
Get Dataset Statistics
getStatistics 3 params → 200400
GET
/croissant
Get Croissant Metadata
getCroissantMetadata 1 param → 200404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Error (4 properties), StatisticsResponse (3 properties), ParquetResponse (2 properties), SizeResponse (2 properties). Each schema is shown below with its type and property counts.

StatisticsResponse
object
3 properties
Error
object
4 properties
SizeResponse
object
2 properties
ParquetResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hugging-face-files-metadata-api-openapi.yml Raw ↑

Other APIs Hugging Face publishes across the network.

Hugging Face Audio API
Hugging Face Chat API
Hugging Face Chat Completions API
Hugging Face Computer Vision API
Hugging Face Data Access API
Hugging Face Dataset Info API
Hugging Face Datasets API
Hugging Face Embeddings API
Hugging Face Endpoints API
Hugging Face Image Generation API
Hugging Face Info API
Hugging Face Models API