Kueri Saldo Pengguna

Dapatkan sisa dan saldo terpakai dari akun pengguna saat ini. Endpoint ini mengembalikan informasi saldo pada tingkat pengguna, terpisah dari token tertentu, untuk melihat saldo akun secara keseluruhan.

curl --request GET \
  --url 'https://api.apimart.ai/v1/user/balance' \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "remain_balance": 100.0,
  "used_balance": 25.5,
  "unlimited_quota": false
}

Authorization

string

wajib

Semua endpoint API memerlukan autentikasi Bearer TokenDapatkan API Key Anda:Kunjungi Halaman Manajemen API Key untuk mendapatkan API Key AndaTambahkan ke header request:

Authorization: Bearer YOUR_API_KEY

Endpoint

GET /v1/user/balance
GET /user/balance

Kedua endpoint memiliki fungsi yang sama, Anda dapat menggunakan salah satu.

Response

success

boolean

Menunjukkan apakah permintaan berhasil

message

string

Pesan error (hanya dikembalikan jika gagal)

remain_balance

float

Sisa saldo pengguna (dikembalikan jika berhasil). Mengembalikan -1 ketika unlimited_quota bernilai true

used_balance

float

Saldo pengguna yang telah digunakan (dikembalikan jika berhasil)

unlimited_quota

boolean

Menunjukkan apakah pengguna memiliki kuota tak terbatas. true berarti tak terbatas, false berarti terbatas

Saldo Token vs Saldo Pengguna

Perbandingan	Saldo Token (`/v1/balance`)	Saldo Pengguna (`/v1/user/balance`)
Cakupan	Satu token	Seluruh akun pengguna
Sumber Data	RemainQuota dan UsedQuota dari token	quota dan used_quota dari pengguna
Kasus Penggunaan	Pantau penggunaan satu API Key	Lihat saldo akun secara keseluruhan
Batasan	Batas kuota tingkat token	Batas kuota tingkat pengguna

Kasus Penggunaan

Lihat saldo akun pengguna secara keseluruhan
Atur pengingat isi ulang dan peringatan saldo
Tampilkan saldo akun di dasbor pengguna

Informasi Satuan SaldoSatuan nilai saldo bergantung pada konfigurasi sistem:

USD - Dolar AS
CNY - Yuan Tiongkok
Tokens - Jumlah token

Pengguna dengan Kuota Tak TerbatasKetika pengguna diatur sebagai kuota tak terbatas:

Field unlimited_quota mengembalikan true
Field remain_balance mengembalikan -1
Pengguna tidak memiliki batasan kuota dan dapat menggunakan API tanpa batas

Error Umum

Pesan Error	Penyebab	Solusi
No Authorization header	Header Authorization tidak diberikan	Tambahkan header `Authorization: Bearer sk-xxxxx`
Failed to get user quota	Pengguna tidak ada	Periksa apakah pengguna yang terkait dengan token tersebut ada
Failed to get used quota	Error kueri database	Hubungi admin untuk memeriksa status sistem

Catatan KeamananAPI Key Anda layaknya sebuah kata sandi. Jaga kerahasiaannya dan jangan dibagikan kepada orang lain. Selalu gunakan HTTPS di lingkungan produksi.

Documentation Index

​Authorization

​Endpoint

​Response

​Saldo Token vs Saldo Pengguna

​Kasus Penggunaan