GPUs

Summarise accelerators

Returns how many accelerators and partitions the tenant selected by the X-CostGraph-Tenant-ID header holds, how many of those accelerators have reported, and how many ran no compute. It also carries two spend figures in currency, both estimated from the catalog rate rather than read off an invoice, so neither is billed cost: gpu_cost_month_to_date covers only the hours elapsed since the start of the current UTC month, and never charges an accelerator for hours before we first saw it; gpu_cost_projected_month is what a whole month at the current fleet and rates would come to. Both are null rather than zero where any accelerator in the fleet has no catalog rate, since a partly priced fleet has no known total.

GET

api

tenant

gpus

summary

Summarise accelerators

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/gpus/summary \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/gpus/summary"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/gpus/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/gpus/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/gpus/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/gpus/summary")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/gpus/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "cards_flagged": 123,
    "currency": "<string>",
    "gpu_cost_month_to_date": 123,
    "gpu_cost_projected_month": 123,
    "gpu_count": 123,
    "idle_gpu_count": 123,
    "idle_partition_count": 123,
    "instances": 123,
    "partitions": 123,
    "priced_cards": 123,
    "reporting_gpu_count": 123,
    "unpriced_cards": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Headers

X-CostGraph-Tenant-ID

string

required

Tenant ID

Query Parameters

model

string

Summarise only one accelerator model

utilization_band

string

Summarise only one utilisation band

instance_id

string

Summarise only the accelerators held by one instance

cluster_id

string

Summarise only the accelerators on the machines of one Kubernetes cluster

provider

string[]

Summarise only one or more cloud providers

placement_kind

string[]

Summarise only accelerators sitting on an instance or in a workload

string

Summarise only accelerators whose model or machine name matches, case-insensitively

partitioned

boolean

Summarise only partitioned or only whole cards

window

string

Summarise only accelerators that reported within this window, as a duration such as 24h, 7d or 30d

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

Summarise accelerators

curl --request GET \
  --url https://api.costgraph.ai/api/v1/tenant/gpus/summary \
  --header 'Authorization: <api-key>' \
  --header 'X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>'

import requests

url = "https://api.costgraph.ai/api/v1/tenant/gpus/summary"

headers = {
    "X-CostGraph-Tenant-ID": "<x-costgraph-tenant-id>",
    "Authorization": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {'X-CostGraph-Tenant-ID': '<x-costgraph-tenant-id>', Authorization: '<api-key>'}
};

fetch('https://api.costgraph.ai/api/v1/tenant/gpus/summary', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.costgraph.ai/api/v1/tenant/gpus/summary",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "X-CostGraph-Tenant-ID: <x-costgraph-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.costgraph.ai/api/v1/tenant/gpus/summary"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.costgraph.ai/api/v1/tenant/gpus/summary")
  .header("X-CostGraph-Tenant-ID", "<x-costgraph-tenant-id>")
  .header("Authorization", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.costgraph.ai/api/v1/tenant/gpus/summary")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-CostGraph-Tenant-ID"] = '<x-costgraph-tenant-id>'
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "message": "some message",
  "status": "success",
  "data": {
    "cards_flagged": 123,
    "currency": "<string>",
    "gpu_cost_month_to_date": 123,
    "gpu_cost_projected_month": 123,
    "gpu_count": 123,
    "idle_gpu_count": 123,
    "idle_partition_count": 123,
    "instances": 123,
    "partitions": 123,
    "priced_cards": 123,
    "reporting_gpu_count": 123,
    "unpriced_cards": 123
  }
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

{
  "message": "some message",
  "status": "error"
}

Getting started

Endpoints

Summarise accelerators

Authorizations

Headers

Query Parameters

Response