Get AI usage

GET

ai-usage

Get AI usage

curl --request GET \
  --url https://boat.dev/api/v1/ai-usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://boat.dev/api/v1/ai-usage', 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://boat.dev/api/v1/ai-usage",
  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: Bearer <token>"
  ],
]);

$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://boat.dev/api/v1/ai-usage"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://boat.dev/api/v1/ai-usage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "ok": true,
  "type": "<string>",
  "accountId": "<string>",
  "profileId": "<string>",
  "since": "2023-12-25",
  "sandboxes": [
    {
      "sandboxId": "<string>",
      "name": "<string>",
      "blocked": true,
      "usage": [
        {
          "day": "2023-12-25",
          "credential": "<string>",
          "model": "<string>",
          "requests": 123,
          "errors": 123,
          "inputTokens": 123,
          "outputTokens": 123,
          "cacheReadTokens": 123,
          "cacheWriteTokens": 123
        }
      ],
      "totals": {
        "requests": 123,
        "errors": 123,
        "inputTokens": 123,
        "outputTokens": 123,
        "cacheReadTokens": 123,
        "cacheWriteTokens": 123
      },
      "dollars": 123
    }
  ],
  "usage": [
    {
      "day": "2023-12-25",
      "credential": "<string>",
      "model": "<string>",
      "requests": 123,
      "errors": 123,
      "inputTokens": 123,
      "outputTokens": 123,
      "cacheReadTokens": 123,
      "cacheWriteTokens": 123
    }
  ],
  "totals": {
    "requests": 123,
    "errors": 123,
    "inputTokens": 123,
    "outputTokens": 123,
    "cacheReadTokens": 123,
    "cacheWriteTokens": 123
  },
  "dollars": 123
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}

Authorizations

Authorization

string

header

required

Boat bearer token in the form boat_.... Service API keys authenticate sandbox operations.

Headers

X-Boat-Org

string

Same as the org query parameter. Query wins when both are set.

Query Parameters

days

integer

default:30

Days of history, today included.

Required range: 1 <= x <= 365

profile

string

A credential profile id. Counts that profile's requests instead of a wallet's.

org

string

Billing wallet for this request: an organization you belong to, by id (team_…) or by name as GET /orgs lists it (case-insensitive), or personal. Omitted, the account's active wallet applies (PATCH /orgs/active; personal until set). Two organizations sharing the name answer 409 ambiguous_org and need the id. Sandboxes and snapshots stay creator-private. On /environments routes, only this query parameter selects the organization's shared environments; the X-Boat-Org header and the active wallet do not apply there. Members read them, owners and admins change them.

Response

The usage.

boolean

required

Example:

true

type

string

required

Stable success envelope discriminator added by v1.

accountId

string | null

required

The wallet the usage is charged to. Null with profile.

profileId

string | null

required

The credential profile whose requests are counted. Null without profile.

since

string<date>

required

First UTC day included.

sandboxes

object[]

required

Show child attributes

usage

object[]

required

Show child attributes

totals

object

required

Token counts are the numbers the provider reports in its replies.

Show child attributes

dollars

number

required

Get AI usage

curl --request GET \
  --url https://boat.dev/api/v1/ai-usage \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://boat.dev/api/v1/ai-usage', 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://boat.dev/api/v1/ai-usage",
  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: Bearer <token>"
  ],
]);

$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://boat.dev/api/v1/ai-usage"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://boat.dev/api/v1/ai-usage")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "ok": true,
  "type": "<string>",
  "accountId": "<string>",
  "profileId": "<string>",
  "since": "2023-12-25",
  "sandboxes": [
    {
      "sandboxId": "<string>",
      "name": "<string>",
      "blocked": true,
      "usage": [
        {
          "day": "2023-12-25",
          "credential": "<string>",
          "model": "<string>",
          "requests": 123,
          "errors": 123,
          "inputTokens": 123,
          "outputTokens": 123,
          "cacheReadTokens": 123,
          "cacheWriteTokens": 123
        }
      ],
      "totals": {
        "requests": 123,
        "errors": 123,
        "inputTokens": 123,
        "outputTokens": 123,
        "cacheReadTokens": 123,
        "cacheWriteTokens": 123
      },
      "dollars": 123
    }
  ],
  "usage": [
    {
      "day": "2023-12-25",
      "credential": "<string>",
      "model": "<string>",
      "requests": 123,
      "errors": 123,
      "inputTokens": 123,
      "outputTokens": 123,
      "cacheReadTokens": 123,
      "cacheWriteTokens": 123
    }
  ],
  "totals": {
    "requests": 123,
    "errors": 123,
    "inputTokens": 123,
    "outputTokens": 123,
    "cacheReadTokens": 123,
    "cacheWriteTokens": 123
  },
  "dollars": 123
}

{
  "ok": false,
  "type": "sandbox.error",
  "status": 401,
  "code": "unauthorized",
  "message": "Unauthorized",
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized",
    "status": 401
  },
  "requestId": "req_01HX..."
}