Hugging Face · Example Payload
Hugging Face Createendpoint Example

Hugging Face Createendpoint 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": "createEndpoint",
  "method": "POST",
  "path": "/endpoint/{namespace}",
  "summary": "Create a New Endpoint",
  "requestExamples": [
    {
      "contentType": "application/json",
      "name": "CreateendpointRequestExample",
      "example": {
        "name": "Example Title",
        "type": "public",
        "provider": {
          "vendor": "aws",
          "region": "example_value"
        },
        "compute": {
          "accelerator": "cpu",
          "instanceType": "example_value",
          "instanceSize": "example_value",
          "scaling": {
            "minReplica": 10,
            "maxReplica": 10,
            "scaleToZeroTimeout": 10
          }
        },
        "model": {
          "repository": "example_value",
          "revision": "example_value",
          "task": "example_value",
          "framework": "pytorch",
          "image": {
            "huggingface": "example_value",
            "custom": {
              "url": "https://www.example.com",
              "health_route": "example_value",
              "env": "example_value"
            }
          }
        }
      }
    }
  ],
  "responseExamples": [
    {
      "status": "201",
      "contentType": "application/json",
      "name": "Createendpoint201Example",
      "example": {
        "name": "Example Title",
        "type": "public",
        "accountId": "500123",
        "provider": {
          "vendor": "aws",
          "region": "example_value"
        },
        "compute": {
          "accelerator": "example_value",
          "instanceType": "example_value",
          "instanceSize": "example_value",
          "scaling": {
            "minReplica": 10,
            "maxReplica": 10,
            "scaleToZeroTimeout": 10
          }
        },
        "model": {
          "repository": "example_value",
          "revision": "example_value",
          "task": "example_value",
          "framework": "pytorch",
          "image": {
            "huggingface": "example_value",
            "custom": {
              "url": "https://www.example.com",
              "port": 10
            }
          }
        },
        "status": {
          "state": "pending",
          "message": "example_value",
          "createdAt": "2026-01-15T10:30:00Z",
          "updatedAt": "2026-01-15T10:30:00Z",
          "url": "https://www.example.com"
        },
        "url": "https://www.example.com"
      }
    },
    {
      "status": "400",
      "contentType": "application/json",
      "name": "Createendpoint400Example",
      "example": {
        "error": "example_value",
        "statusCode": 10
      }
    },
    {
      "status": "401",
      "contentType": "application/json",
      "name": "Createendpoint401Example",
      "example": {
        "error": "example_value",
        "statusCode": 10
      }
    },
    {
      "status": "409",
      "contentType": "application/json",
      "name": "Createendpoint409Example",
      "example": {
        "error": "example_value",
        "statusCode": 10
      }
    }
  ]
}