Get credit balances and current usage

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/credits \
  --header 'Authorization: Bearer <token>'

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

fetch('https://service.abundly.ai/workspaceapi/credits', 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://service.abundly.ai/workspaceapi/credits",
  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://service.abundly.ai/workspaceapi/credits"

	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://service.abundly.ai/workspaceapi/credits")

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

{
  "totalBalance": 123,
  "totalBalanceNoNegative": 123,
  "topupBalance": 123,
  "subscriptionBalance": 123,
  "agentUsage": {},
  "groupUsage": {},
  "lastUpdated": "<string>",
  "defaultDailyCreditLimitPerAgent": 123
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

GET

workspaceapi

credits

Get credit balances and current usage

curl --request GET \
  --url https://service.abundly.ai/workspaceapi/credits \
  --header 'Authorization: Bearer <token>'

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

fetch('https://service.abundly.ai/workspaceapi/credits', 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://service.abundly.ai/workspaceapi/credits",
  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://service.abundly.ai/workspaceapi/credits"

	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://service.abundly.ai/workspaceapi/credits")

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

{
  "totalBalance": 123,
  "totalBalanceNoNegative": 123,
  "topupBalance": 123,
  "subscriptionBalance": 123,
  "agentUsage": {},
  "groupUsage": {},
  "lastUpdated": "<string>",
  "defaultDailyCreditLimitPerAgent": 123
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Authorizations

Authorization

string

header

required

Workspace API key (wk_) with the Workspace read API scope enabled.

Response

Success. Empty result sets are also 200.

Live snapshot — today per agent, current month per team.

totalBalance

number

required

totalBalanceNoNegative

number

required

totalBalance floored at zero.

topupBalance

number

required

subscriptionBalance

number

required

agentUsage

object

required

Keyed by agent id. Covers every agent, including disabled and private ones.

Show child attributes

groupUsage

object

required

Keyed by team id.

Show child attributes

lastUpdated

string

defaultDailyCreditLimitPerAgent

number

{key}

any