Check your wallet
curl --request GET \
--url https://api.example.com/v1/walletimport requests
url = "https://api.example.com/v1/wallet"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/wallet', 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.example.com/v1/wallet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/wallet"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/wallet")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/wallet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyReference
Check your wallet
Read your API wallet balance — deposit, free credit, and how many scans you can still run.
GET
/
v1
/
wallet
Check your wallet
curl --request GET \
--url https://api.example.com/v1/walletimport requests
url = "https://api.example.com/v1/wallet"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/wallet', 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.example.com/v1/wallet",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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.example.com/v1/wallet"
req, _ := http.NewRequest("GET", url, nil)
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.example.com/v1/wallet")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/wallet")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyCheck how much is in your API wallet before submitting scans — useful from a script or an agent so you never get surprised by a
A debit is settled the first time you fetch a completed scan, so
See Errors for the full list.
402 insufficient_balance. Read-only: it never debits.
curl https://www.thesapientcompany.com/api/v1/wallet \
-H "Authorization: Bearer sk_live_YOUR_KEY_HERE"
Response
{
"object": "wallet",
"currency": "usd",
"deposit_balance_usd": 40.00,
"free_credit_remaining_usd": 2.50,
"free_credit_monthly_usd": 2.50,
"free_credit_period_start": "2026-06-01",
"total_available_usd": 42.50,
"price_per_scan_usd": { "qualia": 2.50 },
"scans_remaining_estimate": 17
}
| Field | Meaning |
|---|---|
deposit_balance_usd | Your prepaid deposit remaining. Top up in Settings → API. |
free_credit_remaining_usd | This month’s free credit left (the first $2.50 of usage each month is free). |
free_credit_monthly_usd | The monthly free allowance, reset on the 1st (UTC). |
free_credit_period_start | First day of the current free-credit month (UTC). |
total_available_usd | deposit_balance_usd + free_credit_remaining_usd — what you can actually spend now. |
price_per_scan_usd | Current per-scan price by model (Qualia is the default and only available model). |
scans_remaining_estimate | total_available_usd ÷ the Qualia price, rounded down — roughly how many scans you can still run. |
total_available_usd reflects everything charged up to now.
Errors
| Status | error | When |
|---|---|---|
401 | unauthorized | Missing, invalid, or revoked API key. |
405 | method_not_allowed | Use GET. |
⌘I