AutoPilot for CI savings

Measured savings of jobs AutoPilot for CI routed off their default runner, in total and per workflow. Each workflow AutoPilot made a decision for in the period is listed, also with no savings yet, with the share of its jobs that ran on each runner (largest first), its AutoPilot state (managed when it routed a job off the default runner, learning when every job lacked history, otherwise limited with the most common reason), the settings set in the workflow file (locked_keys) and the effective policy with where it comes from. Each job is compared with the p75 cost and wall time of the same job on its default runner over the 30 days before AutoPilot first routed it. When the job had fewer than 10 runs there, the baseline is estimated as the default runner’s list price for the job’s own measured run, with no time saving claimed (estimated_jobs); only when that is unknown too does the job count in no_baseline_jobs and add no savings. A job that would have run free on its default runner saves nothing. net_usd subtracts what the routing jobs themselves cost. Defaults to the last 30 days.

GET

api

tenant

autopilot

savings

AutoPilot for CI savings

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

import requests

url = "https://api.costgraph.ai/api/v1/tenant/ci/autopilot/savings"

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/ci/autopilot/savings', 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/ci/autopilot/savings",
  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/ci/autopilot/savings"

	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/ci/autopilot/savings")
  .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/ci/autopilot/savings")

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": {
    "total": {
      "added_usd": 123,
      "added_wall_seconds": 123,
      "estimated_jobs": 123,
      "net_usd": 123,
      "no_baseline_jobs": 123,
      "repository": "<string>",
      "routed_jobs": 123,
      "routing_cost_usd": 123,
      "runners": [
        {
          "label": "<string>",
          "provider": "<string>",
          "share": 123
        }
      ],
      "saved_usd": 123,
      "saved_wall_seconds": 123,
      "workflow": "<string>",
      "workflow_path": "<string>",
      "autopilot": {
        "locked_keys": [
          "<string>"
        ],
        "reasons": [
          "<string>"
        ],
        "state": "managed",
        "via": "<string>",
        "last_change_at": "<string>",
        "paused_until": "<string>",
        "projected_savings_monthly": 123,
        "realised_savings_monthly": 123,
        "storage": true
      },
      "policy": "cheapest",
      "policy_from": "git"
    },
    "workflows": [
      {
        "added_usd": 123,
        "added_wall_seconds": 123,
        "estimated_jobs": 123,
        "net_usd": 123,
        "no_baseline_jobs": 123,
        "repository": "<string>",
        "routed_jobs": 123,
        "routing_cost_usd": 123,
        "runners": [
          {
            "label": "<string>",
            "provider": "<string>",
            "share": 123
          }
        ],
        "saved_usd": 123,
        "saved_wall_seconds": 123,
        "workflow": "<string>",
        "workflow_path": "<string>",
        "autopilot": {
          "locked_keys": [
            "<string>"
          ],
          "reasons": [
            "<string>"
          ],
          "state": "managed",
          "via": "<string>",
          "last_change_at": "<string>",
          "paused_until": "<string>",
          "projected_savings_monthly": 123,
          "realised_savings_monthly": 123,
          "storage": true
        },
        "policy": "cheapest",
        "policy_from": "git"
      }
    ]
  }
}

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

Authorizations

Authorization

string

header

required

Enter "Bearer {token}"

Headers

X-CostGraph-Tenant-ID

string

required

Tenant ID

Query Parameters

from

string

First day, YYYY-MM-DD

string

Day after the last day, YYYY-MM-DD

repository

string

owner/name

workflow_path

string

Workflow file

provider

string

Runner provider the jobs were routed to

Response

message

string

required

Example:

"some message"

status

string

required

Example:

"success"

data

object

Show child attributes

AutoPilot for CI savings

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

import requests

url = "https://api.costgraph.ai/api/v1/tenant/ci/autopilot/savings"

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/ci/autopilot/savings', 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/ci/autopilot/savings",
  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/ci/autopilot/savings"

	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/ci/autopilot/savings")
  .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/ci/autopilot/savings")

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": {
    "total": {
      "added_usd": 123,
      "added_wall_seconds": 123,
      "estimated_jobs": 123,
      "net_usd": 123,
      "no_baseline_jobs": 123,
      "repository": "<string>",
      "routed_jobs": 123,
      "routing_cost_usd": 123,
      "runners": [
        {
          "label": "<string>",
          "provider": "<string>",
          "share": 123
        }
      ],
      "saved_usd": 123,
      "saved_wall_seconds": 123,
      "workflow": "<string>",
      "workflow_path": "<string>",
      "autopilot": {
        "locked_keys": [
          "<string>"
        ],
        "reasons": [
          "<string>"
        ],
        "state": "managed",
        "via": "<string>",
        "last_change_at": "<string>",
        "paused_until": "<string>",
        "projected_savings_monthly": 123,
        "realised_savings_monthly": 123,
        "storage": true
      },
      "policy": "cheapest",
      "policy_from": "git"
    },
    "workflows": [
      {
        "added_usd": 123,
        "added_wall_seconds": 123,
        "estimated_jobs": 123,
        "net_usd": 123,
        "no_baseline_jobs": 123,
        "repository": "<string>",
        "routed_jobs": 123,
        "routing_cost_usd": 123,
        "runners": [
          {
            "label": "<string>",
            "provider": "<string>",
            "share": 123
          }
        ],
        "saved_usd": 123,
        "saved_wall_seconds": 123,
        "workflow": "<string>",
        "workflow_path": "<string>",
        "autopilot": {
          "locked_keys": [
            "<string>"
          ],
          "reasons": [
            "<string>"
          ],
          "state": "managed",
          "via": "<string>",
          "last_change_at": "<string>",
          "paused_until": "<string>",
          "projected_savings_monthly": 123,
          "realised_savings_monthly": 123,
          "storage": true
        },
        "policy": "cheapest",
        "policy_from": "git"
      }
    ]
  }
}

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

Getting started

Endpoints

AutoPilot for CI savings

Authorizations

Headers

Query Parameters

Response