Hugging Face Natural Language Processing API

openapi: 3.1.0
info:
  title: Hugging Face Dataset Viewer Audio Natural Language Processing API
  description: Query and visualize datasets stored on the Hugging Face Hub through a lightweight REST API. Get dataset splits, preview rows, search and filter data, access Parquet files, retrieve size statistics, and obtain Croissant metadata - all without downloading the entire dataset.
  version: 1.0.0
  termsOfService: https://huggingface.co/terms-of-service
  contact:
    name: Hugging Face Support
    url: https://huggingface.co/support
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://datasets-server.huggingface.co
  description: Hugging Face Dataset Viewer production server
security:
- {}
- bearerAuth: []
tags:
- name: Natural Language Processing
  description: NLP tasks including text generation, classification, and translation
paths:
  /models/{model_id}:
    post:
      summary: Run Inference on a Model
      description: Run inference on any model hosted on the Hugging Face Hub. The request and response format depends on the model's pipeline task.
      operationId: runInference
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        description: The model ID on the Hugging Face Hub (e.g., gpt2, bert-base-uncased)
        schema:
          type: string
        example: gpt2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InferenceRequest'
            examples:
              RuninferenceRequestExample:
                summary: Default runInference request
                x-microcks-default: true
                value:
                  inputs: example_value
                  parameters: example_value
                  options:
                    use_cache: true
                    wait_for_model: true
      responses:
        '200':
          description: Successful inference result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceResponse'
              examples:
                Runinference200Example:
                  summary: Default runInference 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Bad request - invalid input parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runinference400Example:
                  summary: Default runInference 400 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '401':
          description: Unauthorized - invalid or missing API token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runinference401Example:
                  summary: Default runInference 401 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '403':
          description: Forbidden - insufficient permissions for this model
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runinference403Example:
                  summary: Default runInference 403 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '404':
          description: Model not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runinference404Example:
                  summary: Default runInference 404 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runinference429Example:
                  summary: Default runInference 429 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '503':
          description: Model is loading or unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelLoadingResponse'
              examples:
                Runinference503Example:
                  summary: Default runInference 503 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /pipeline/{task}:
    post:
      summary: Run Inference by Task Pipeline
      description: Run inference using a recommended model for a specific task pipeline. Hugging Face selects the best available model for the given task.
      operationId: runPipelineInference
      tags:
      - Natural Language Processing
      parameters:
      - name: task
        in: path
        required: true
        description: The pipeline task type (e.g., text-generation, text-classification, summarization)
        schema:
          type: string
          enum:
          - text-generation
          - text-classification
          - token-classification
          - question-answering
          - summarization
          - translation
          - fill-mask
          - text2text-generation
          - feature-extraction
          - sentence-similarity
          - zero-shot-classification
          - table-question-answering
          - conversational
          - image-classification
          - object-detection
          - image-segmentation
          - image-to-text
          - text-to-image
          - automatic-speech-recognition
          - audio-classification
          - text-to-speech
        example: text-generation
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InferenceRequest'
            examples:
              RunpipelineinferenceRequestExample:
                summary: Default runPipelineInference request
                x-microcks-default: true
                value:
                  inputs: example_value
                  parameters: example_value
                  options:
                    use_cache: true
                    wait_for_model: true
      responses:
        '200':
          description: Successful inference result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InferenceResponse'
              examples:
                Runpipelineinference200Example:
                  summary: Default runPipelineInference 200 response
                  x-microcks-default: true
                  value: {}
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runpipelineinference400Example:
                  summary: Default runPipelineInference 400 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Runpipelineinference429Example:
                  summary: Default runPipelineInference 429 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/text-generation:
    post:
      summary: Text Generation Inference
      description: Generate text using a language model. Supports parameters like temperature, top_p, max_new_tokens, and repetition_penalty.
      operationId: textGeneration
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: gpt2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TextGenerationRequest'
            examples:
              TextgenerationRequestExample:
                summary: Default textGeneration request
                x-microcks-default: true
                value:
                  inputs: example_value
                  parameters:
                    max_new_tokens: 10
                    temperature: 42.5
                    top_p: 42.5
                    top_k: 10
                    repetition_penalty: 42.5
                    do_sample: true
                    return_full_text: true
                    stop:
                    - example_value
                  options:
                    use_cache: true
                    wait_for_model: true
      responses:
        '200':
          description: Generated text response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TextGenerationResponse'
              examples:
                Textgeneration200Example:
                  summary: Default textGeneration 200 response
                  x-microcks-default: true
                  value:
                  - generated_text: example_value
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Textgeneration400Example:
                  summary: Default textGeneration 400 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
        '503':
          description: Model is loading
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelLoadingResponse'
              examples:
                Textgeneration503Example:
                  summary: Default textGeneration 503 response
                  x-microcks-default: true
                  value:
                    error: example_value
                    estimated_time: 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/text-classification:
    post:
      summary: Text Classification Inference
      description: Classify text into predefined categories using a text classification model such as sentiment analysis.
      operationId: textClassification
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: distilbert-base-uncased-finetuned-sst-2-english
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TextClassificationRequest'
            examples:
              TextclassificationRequestExample:
                summary: Default textClassification request
                x-microcks-default: true
                value:
                  inputs: example_value
      responses:
        '200':
          description: Classification results
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    $ref: '#/components/schemas/ClassificationResult'
              examples:
                Textclassification200Example:
                  summary: Default textClassification 200 response
                  x-microcks-default: true
                  value:
                  - - label: Example Title
                      score: 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/question-answering:
    post:
      summary: Question Answering Inference
      description: Extract answers from a given context using a question answering model.
      operationId: questionAnswering
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: deepset/roberta-base-squad2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/QuestionAnsweringRequest'
            examples:
              QuestionansweringRequestExample:
                summary: Default questionAnswering request
                x-microcks-default: true
                value:
                  inputs:
                    question: example_value
                    context: example_value
      responses:
        '200':
          description: Answer extracted from context
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/QuestionAnsweringResponse'
              examples:
                Questionanswering200Example:
                  summary: Default questionAnswering 200 response
                  x-microcks-default: true
                  value:
                    answer: example_value
                    score: 42.5
                    start: 10
                    end: 10
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/summarization:
    post:
      summary: Text Summarization Inference
      description: Summarize a long text into a shorter version.
      operationId: summarization
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: facebook/bart-large-cnn
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummarizationRequest'
            examples:
              SummarizationRequestExample:
                summary: Default summarization request
                x-microcks-default: true
                value:
                  inputs: example_value
                  parameters:
                    min_length: 10
                    max_length: 10
      responses:
        '200':
          description: Summarized text
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SummarizationResponse'
              examples:
                Summarization200Example:
                  summary: Default summarization 200 response
                  x-microcks-default: true
                  value:
                  - summary_text: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/translation:
    post:
      summary: Translation Inference
      description: Translate text from one language to another.
      operationId: translation
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: Helsinki-NLP/opus-mt-en-fr
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TranslationRequest'
            examples:
              TranslationRequestExample:
                summary: Default translation request
                x-microcks-default: true
                value:
                  inputs: example_value
      responses:
        '200':
          description: Translated text
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TranslationResponse'
              examples:
                Translation200Example:
                  summary: Default translation 200 response
                  x-microcks-default: true
                  value:
                  - translation_text: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/fill-mask:
    post:
      summary: Fill Mask Inference
      description: Fill in a masked token in a sentence using a masked language model.
      operationId: fillMask
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: bert-base-uncased
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FillMaskRequest'
            examples:
              FillmaskRequestExample:
                summary: Default fillMask request
                x-microcks-default: true
                value:
                  inputs: example_value
      responses:
        '200':
          description: Predicted tokens for the mask
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/FillMaskResponse'
              examples:
                Fillmask200Example:
                  summary: Default fillMask 200 response
                  x-microcks-default: true
                  value:
                  - sequence: example_value
                    score: 42.5
                    token: 10
                    token_str: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/feature-extraction:
    post:
      summary: Feature Extraction Inference
      description: Extract dense vector representations (embeddings) from text input.
      operationId: featureExtraction
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: sentence-transformers/all-MiniLM-L6-v2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/FeatureExtractionRequest'
            examples:
              FeatureextractionRequestExample:
                summary: Default featureExtraction request
                x-microcks-default: true
                value:
                  inputs: example_value
      responses:
        '200':
          description: Extracted feature vectors
          content:
            application/json:
              schema:
                type: array
                items:
                  type: array
                  items:
                    type: number
              examples:
                Featureextraction200Example:
                  summary: Default featureExtraction 200 response
                  x-microcks-default: true
                  value:
                  - - 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/zero-shot-classification:
    post:
      summary: Zero-shot Classification Inference
      description: Classify text into categories that the model has not been explicitly trained on using natural language inference.
      operationId: zeroShotClassification
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: facebook/bart-large-mnli
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZeroShotClassificationRequest'
            examples:
              ZeroshotclassificationRequestExample:
                summary: Default zeroShotClassification request
                x-microcks-default: true
                value:
                  inputs: example_value
                  parameters:
                    candidate_labels:
                    - example_value
                    multi_label: true
      responses:
        '200':
          description: Classification scores for each candidate label
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ZeroShotClassificationResponse'
              examples:
                Zeroshotclassification200Example:
                  summary: Default zeroShotClassification 200 response
                  x-microcks-default: true
                  value:
                    sequence: example_value
                    labels:
                    - example_value
                    scores:
                    - 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models/{model_id}/sentence-similarity:
    post:
      summary: Sentence Similarity Inference
      description: Compute similarity scores between a source sentence and target sentences.
      operationId: sentenceSimilarity
      tags:
      - Natural Language Processing
      parameters:
      - name: model_id
        in: path
        required: true
        schema:
          type: string
        example: sentence-transformers/all-MiniLM-L6-v2
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SentenceSimilarityRequest'
            examples:
              SentencesimilarityRequestExample:
                summary: Default sentenceSimilarity request
                x-microcks-default: true
                value:
                  inputs:
                    source_sentence: example_value
                    sentences:
                    - example_value
      responses:
        '200':
          description: Similarity scores
          content:
            application/json:
              schema:
                type: array
                items:
                  type: number
                  format: float
              examples:
                Sentencesimilarity200Example:
                  summary: Default sentenceSimilarity 200 response
                  x-microcks-default: true
                  value:
                  - 42.5
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    InferenceResponse:
      oneOf:
      - type: array
        items:
          type: object
      - type: object
      - type: string
      description: The inference result - format depends on the task
    SummarizationResponse:
      type: object
      properties:
        summary_text:
          type: string
          description: The summarized text
          example: example_value
    ClassificationResult:
      type: object
      properties:
        label:
          type: string
          description: The predicted label
          example: POSITIVE
        score:
          type: number
          format: float
          description: Confidence score for the label
          example: 0.9998
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
          example: example_value
        estimated_time:
          type: number
          format: float
          description: Estimated time until availability (for loading errors)
          example: 42.5
    TextGenerationResponse:
      type: object
      properties:
        generated_text:
          type: string
          description: The generated text
          example: example_value
    ZeroShotClassificationRequest:
      type: object
      required:
      - inputs
      - parameters
      properties:
        inputs:
          type: string
          description: The text to classify
          example: example_value
        parameters:
          type: object
          required:
          - candidate_labels
          properties:
            candidate_labels:
              type: array
              items:
                type: string
              description: Labels to classify against
            multi_label:
              type: boolean
              default: false
              description: Whether multiple labels can be true
          example: example_value
    TextGenerationRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: string
          description: The prompt text to generate from
          example: The answer to the universe is
        parameters:
          type: object
          properties:
            max_new_tokens:
              type: integer
              description: Maximum number of tokens to generate
              example: 250
            temperature:
              type: number
              format: float
              description: Sampling temperature (0.0 to 100.0)
              example: 1.0
            top_p:
              type: number
              format: float
              description: Nucleus sampling parameter
              example: 0.95
            top_k:
              type: integer
              description: Top-k sampling parameter
              example: 50
            repetition_penalty:
              type: number
              format: float
              description: Repetition penalty (1.0 means no penalty)
              example: 1.0
            do_sample:
              type: boolean
              description: Whether to use sampling instead of greedy decoding
              default: true
            return_full_text:
              type: boolean
              description: Whether to return the full text including the prompt
              default: true
            stop:
              type: array
              items:
                type: string
              description: Stop sequences to halt generation
          example: example_value
        options:
          type: object
          properties:
            use_cache:
              type: boolean
              default: true
            wait_for_model:
              type: boolean
              default: false
          example: example_value
    TranslationResponse:
      type: object
      properties:
        translation_text:
          type: string
          description: The translated text
          example: example_value
    SentenceSimilarityRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: object
          required:
          - source_sentence
          - sentences
          properties:
            source_sentence:
              type: string
              description: The source sentence to compare against
            sentences:
              type: array
              items:
                type: string
              description: Target sentences to compare with
          example: example_value
    QuestionAnsweringRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: object
          required:
          - question
          - context
          properties:
            question:
              type: string
              description: The question to answer
              example: What is the capital of France?
            context:
              type: string
              description: The context containing the answer
              example: France is a country in Europe. Its capital is Paris.
          example: example_value
    InferenceRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          description: The input data for inference
          example: example_value
        parameters:
          type: object
          description: Task-specific parameters
          example: example_value
        options:
          type: object
          properties:
            use_cache:
              type: boolean
              default: true
              description: Use cached results if available
            wait_for_model:
              type: boolean
              default: false
              description: Wait for the model to load instead of returning 503
          example: example_value
    FillMaskResponse:
      type: object
      properties:
        sequence:
          type: string
          description: The complete text with filled mask
          example: example_value
        score:
          type: number
          format: float
          description: Confidence score for the prediction
          example: 42.5
        token:
          type: integer
          description: Token ID of the predicted word
          example: 10
        token_str:
          type: string
          description: The predicted word
          example: example_value
    FillMaskRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: string
          description: Text with [MASK] token to fill
          example: The capital of France is [MASK].
    ModelLoadingResponse:
      type: object
      properties:
        error:
          type: string
          description: Error message indicating the model is loading
          example: Model is currently loading
        estimated_time:
          type: number
          format: float
          description: Estimated time in seconds until the model is ready
          example: 42.5
    TranslationRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: string
          description: The text to translate
          example: Hello, how are you?
    SummarizationRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: string
          description: The text to summarize
          example: example_value
        parameters:
          type: object
          properties:
            min_length:
              type: integer
              description: Minimum length of the summary
            max_length:
              type: integer
              description: Maximum length of the summary
          example: example_value
    FeatureExtractionRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          description: The text input(s) for embedding extraction
          example: example_value
    QuestionAnsweringResponse:
      type: object
      properties:
        answer:
          type: string
          description: The extracted answer
          example: Paris
        score:
          type: number
          format: float
          description: Confidence score
          example: 42.5
        start:
          type: integer
          description: Start character position in context
          example: 10
        end:
          type: integer
          description: End character position in context
          example: 10
    TextClassificationRequest:
      type: object
      required:
      - inputs
      properties:
        inputs:
          type: string
          description: The text to classify
          example: I love this movie!
    ZeroShotClassificationResponse:
      type: object
      properties:
        sequence:
          type: string
          example: example_value
        labels:
          type: array
          items:
            type: string
          example: []
        scores:
          type: array
          items:
            type: number
            format

# --- truncated at 32 KB (32 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hugging-face/refs/heads/main/openapi/hugging-face-natural-language-processing-api-openapi.yml