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 Natural Language Processing API

NLP tasks including text generation, classification, and translation

Hugging Face Natural Language Processing 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 Natural Language Processing. 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 11 operations across 11 paths, and defines 20 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.

11 operations 11 paths 20 schemas 11 POST

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 Natural Language Processing 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 11

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

Natural Language Processing 11

NLP tasks including text generation, classification, and translation

POST
/models/{model_id}
Run Inference on a Model
runInference 1 param body → 200400401403404429503
POST
/pipeline/{task}
Run Inference by Task Pipeline
runPipelineInference 1 param body → 200400429
POST
/models/{model_id}/text-generation
Text Generation Inference
textGeneration 1 param body → 200400503
POST
/models/{model_id}/text-classification
Text Classification Inference
textClassification 1 param body → 200
POST
/models/{model_id}/question-answering
Question Answering Inference
questionAnswering 1 param body → 200
POST
/models/{model_id}/summarization
Text Summarization Inference
summarization 1 param body → 200
POST
/models/{model_id}/translation
Translation Inference
translation 1 param body → 200
POST
/models/{model_id}/fill-mask
Fill Mask Inference
fillMask 1 param body → 200
POST
/models/{model_id}/feature-extraction
Feature Extraction Inference
featureExtraction 1 param body → 200
POST
/models/{model_id}/zero-shot-classification
Zero-shot Classification Inference
zeroShotClassification 1 param body → 200
POST
/models/{model_id}/sentence-similarity
Sentence Similarity Inference
sentenceSimilarity 1 param body → 200

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are FillMaskResponse (4 properties), QuestionAnsweringResponse (4 properties), InferenceRequest (3 properties), TextGenerationRequest (3 properties). Each schema is shown below with its type and property counts.

InferenceResponse
The inference result - format depends on the task
SummarizationResponse
object
1 property
ClassificationResult
object
2 properties
Error
object
2 properties
TextGenerationResponse
object
1 property
ZeroShotClassificationRequest
object
2 properties 2 required
TextGenerationRequest
object
3 properties 1 required
TranslationResponse
object
1 property
SentenceSimilarityRequest
object
1 property 1 required
QuestionAnsweringRequest
object
1 property 1 required
InferenceRequest
object
3 properties 1 required
FillMaskResponse
object
4 properties
FillMaskRequest
object
1 property 1 required
ModelLoadingResponse
object
2 properties
TranslationRequest
object
1 property 1 required
SummarizationRequest
object
2 properties 1 required
FeatureExtractionRequest
object
1 property 1 required
QuestionAnsweringResponse
object
4 properties
TextClassificationRequest
object
1 property 1 required
ZeroShotClassificationResponse
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hugging-face-natural-language-processing-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 Files & Metadata API
Hugging Face Image Generation API
Hugging Face Info API