Hugging Face · Example Payload

Hugging Face Isvalid Example

Hugging Face Isvalid Example is an example object payload from Hugging Face, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdmethodpathsummaryrequestExamplesresponseExamples

Example Payload

{
  "operationId": "isValid",
  "method": "GET",
  "path": "/is-valid",
  "summary": "Check Dataset Validity",
  "requestExamples": [],
  "responseExamples": [
    {
      "status": "200",
      "contentType": "application/json",
      "name": "Isvalid200Example",
      "example": {
        "preview": true,
        "viewer": true,
        "search": true,
        "filter": true,
        "statistics": true
      }
    },
    {
      "status": "404",
      "contentType": "application/json",
      "name": "Isvalid404Example",
      "example": {
        "error": "example_value",
        "cause_exception": "example_value",
        "cause_message": "example_value",
        "cause_traceback": [
          "example_value"
        ]
      }
    },
    {
      "status": "500",
      "contentType": "application/json",
      "name": "Isvalid500Example",
      "example": {
        "error": "example_value",
        "cause_exception": "example_value",
        "cause_message": "example_value",
        "cause_traceback": [
          "example_value"
        ]
      }
    }
  ]
}