Pular para o conteúdo
Referência de API
Referência de API

Recuperar o saldo

Recuperar o saldo pago e de bônus restante, além dos totais de uso atuais.

Ver Markdown

Recuperar o saldo pago e de bônus restante, além dos totais de uso atuais.

Endpoint

GET /api/v1/me/balance
URL base
https://runapi.ai
Versão da API
v1
Autenticação
Authorization: Bearer YOUR_API_KEY
Autorização
Retorna o saldo da conta vinculada à Chave de API Standard apresentada.
02

Resposta de sucesso

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
}
03

Resposta de erro (401)

HTTP 401
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

JSON 
{
  "error": "Authentication required"
}
04

Resposta de erro (403)

HTTP 403
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Exemplo de cURL

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