{
  "opencollection": "1.0.0",
  "info": {
    "name": "KServe Open Inference Protocol Health API",
    "version": "v2"
  },
  "items": [
    {
      "info": {
        "name": "Health",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Check Server Liveness",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://inference.kserve.example.com/v2/health/live"
          },
          "docs": "The server liveness API indicates if the inference server is able to receive and respond to metadata and inference requests. Can be used directly to implement the Kubernetes livenessProbe."
        },
        {
          "info": {
            "name": "Check Server Readiness",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://inference.kserve.example.com/v2/health/ready"
          },
          "docs": "The server readiness API indicates if all the models are ready for inferencing. Can be used directly to implement the Kubernetes readinessProbe."
        },
        {
          "info": {
            "name": "Check Model Readiness",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://inference.kserve.example.com/v2/models/:model_name/ready",
            "params": [
              {
                "name": "model_name",
                "value": "bert-sentiment-classifier",
                "type": "path",
                "description": "Name of the model to check readiness for."
              }
            ]
          },
          "docs": "The model readiness API indicates if a specific model is ready for inferencing. Check this before submitting inference requests to a newly deployed model."
        },
        {
          "info": {
            "name": "Check Model Version Readiness",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://inference.kserve.example.com/v2/models/:model_name/versions/:model_version/ready",
            "params": [
              {
                "name": "model_name",
                "value": "bert-sentiment-classifier",
                "type": "path"
              },
              {
                "name": "model_version",
                "value": "2",
                "type": "path"
              }
            ]
          },
          "docs": "Check if a specific version of a model is ready for inference."
        }
      ]
    }
  ],
  "bundled": true
}