Langsung ke konten utama
GET
/
v1
/
balance
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Documentation Index

Fetch the complete documentation index at: https://docs.apimart.ai/llms.txt

Use this file to discover all available pages before exploring further.

Dapatkan sisa dan saldo terpakai dari API Key (token) saat ini. Endpoint ini digunakan untuk memantau penggunaan satu token.
curl --request GET \
  --url 'https://api.apimart.ai/v1/balance' \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "remain_balance": 10.5,
  "used_balance": 2.3,
  "unlimited_quota": false
}

Authorization

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/balance
GET /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 token (dikembalikan jika berhasil). Mengembalikan -1 ketika unlimited_quota bernilai true
used_balance
float
Saldo token yang telah digunakan (dikembalikan jika berhasil)
unlimited_quota
boolean
Menunjukkan apakah token memiliki kuota tak terbatas. true berarti tak terbatas, false berarti terbatas

Kasus Penggunaan

  • Pantau konsumsi satu API Key
  • Tampilkan saldo token saat ini di aplikasi Anda
  • Atur peringatan saldo ketika saldo turun di bawah ambang batas
Informasi Satuan SaldoSatuan nilai saldo bergantung pada konfigurasi sistem:
  • USD - Dolar AS
  • CNY - Yuan Tiongkok
  • Tokens - Jumlah token
Token dengan Kuota Tak TerbatasKetika token diatur sebagai kuota tak terbatas:
  • Field unlimited_quota mengembalikan true
  • Field remain_balance mengembalikan -1
  • Token tidak memiliki batasan kuota dan dapat digunakan tanpa batas

Error Umum

Pesan ErrorPenyebabSolusi
No Authorization headerHeader Authorization tidak diberikanTambahkan header Authorization: Bearer sk-xxxxx
Failed to get token infoToken tidak ada atau telah dihapusPeriksa apakah token key sudah benar
Catatan KeamananAPI Key Anda layaknya sebuah kata sandi. Jaga kerahasiaannya dan jangan dibagikan kepada orang lain. Selalu gunakan HTTPS di lingkungan produksi.