{
  "opencollection": "1.0.0",
  "info": {
    "name": "NVIDIA Run:ai Access Keys Pods API",
    "version": "latest"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Pods",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List pods.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/workloads/pods",
            "params": [
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "Return only deleted resources when `true`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first item returned in the collection."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return."
              },
              {
                "name": "sortOrder",
                "value": "",
                "type": "query",
                "description": "Sort results in descending or ascending order."
              },
              {
                "name": "sortBy",
                "value": "",
                "type": "query",
                "description": "Sort results using a parameter."
              },
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results using a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contains, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`."
              },
              {
                "name": "verbosity",
                "value": "full",
                "type": "query",
                "description": "response verbosity level. if full, the response includes workloadName and projectName fields.\n"
              },
              {
                "name": "completed",
                "value": "",
                "type": "query",
                "description": "Return only completed resources when 'true', return only non-completed resources when 'false'. By default, or when empty, returns all resources."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Retrieve a list of pods from a cluster."
        },
        {
          "info": {
            "name": "Get pod metrics data.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/workloads/:workloadId/pods/:podId/metrics",
            "params": [
              {
                "name": "workloadId",
                "value": "",
                "type": "path",
                "description": "The  Universally Unique Identifier (UUID) of the workload."
              },
              {
                "name": "podId",
                "value": "",
                "type": "path",
                "description": "The requested pod id."
              },
              {
                "name": "metricType",
                "value": "",
                "type": "query",
                "description": "Specify which metric data to request. Advanced GPU metrics are only supported if the 'Advanced GPU Metrics' feature flag in the settings is enabled."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Start date of time range to fetch data in ISO 8601 timestamp format."
              },
              {
                "name": "end",
                "value": "",
                "type": "query",
                "description": "End date of time range to fetch data in ISO 8601 timestamp format."
              },
              {
                "name": "numberOfSamples",
                "value": "",
                "type": "query",
                "description": "The number of samples to take in the specified time range."
              }
            ]
          },
          "docs": "Retrieve pod's metrics data for use in analysis applications."
        },
        {
          "info": {
            "name": "Get workload pods by id.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/workloads/:workloadId/pods",
            "params": [
              {
                "name": "workloadId",
                "value": "",
                "type": "path",
                "description": "The  Universally Unique Identifier (UUID) of the workload."
              },
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "Return only deleted resources when `true`."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "The offset of the first item returned in the collection."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "The maximum number of entries to return."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Retrieve the details of workload pods by workload id."
        },
        {
          "info": {
            "name": "Get pods count.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/workloads/pods/count",
            "params": [
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "Return only deleted resources when `true`."
              },
              {
                "name": "filterBy",
                "value": "",
                "type": "query",
                "description": "Filter results using a parameter. Use the format field-name operator value. Operators are `==` Equals, `!=` Not equals, `<=` Less than or equal, `>=` Greater than or equal, `=@` contains, `!@` Does not contains, `=^` Starts with and `=$` Ends with. Dates are in ISO 8601 timestamp format and available for operators `==`, `!=`, `<=` and `>=`."
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "Filter results by a free text search."
              }
            ]
          },
          "docs": "Retrieve the number of pods from a cluster."
        },
        {
          "info": {
            "name": "Get revision pods by id. [Experimental]",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.run.ai/api/v1/workloads/inferences/revisions/:revisionId/pods",
            "params": [
              {
                "name": "revisionId",
                "value": "",
                "type": "path",
                "description": "The  Universally Unique Identifier (UUID) of the revision."
              },
              {
                "name": "deleted",
                "value": "",
                "type": "query",
                "description": "Return only deleted resources when `true`."
              }
            ]
          },
          "docs": "Retrieve the details of revision pods by revision id. Supported for clusters v2.21+."
        }
      ]
    }
  ],
  "bundled": true
}