API Reference

Retrieve the balance

Retrieve the remaining paid and bonus balance plus current usage totals.

Retrieve the remaining paid and bonus balance plus current usage totals.

GET /api/v1/me/balance

Base URL: https://runapi.ai
API version: v1
Authentication: Authorization: Bearer YOUR_API_KEY
Authorization: Returns the balance for the account bound to the presented Standard API key.

Success response

HTTP 200

GET /api/v1/me/balance

JSON

{
  "balance_cents": 1200,
  "bonus_balance_cents": 200,
  "paid_balance_cents": 1000,
  "spent_cents_today": 75,
  "spent_cents_total": 4300
}

HTTP 401

JSON

{
  "error": "Authentication required"
}

HTTP 403

JSON

{
  "error": "Standard API key required"
}

CURL

curl -X GET https://runapi.ai/api/v1/me/balance \
  -H 'Authorization: Bearer YOUR_API_KEY'

Example Retrieve the balance

curl

curl -X GET https://runapi.ai/api/v1/me/balance \
  -H 'Authorization: Bearer YOUR_API_KEY'

HTTP 200 - Success response

{
  "balance_cents": 1200,
  "bonus_balance_cents": 200,
  "paid_balance_cents": 1000,
  "spent_cents_today": 75,
  "spent_cents_total": 4300
}