Skip to main content
GET
cURL
Este endpoint retorna todos os alertas de gastos (spending limits) do usuário autenticado, com informações sobre gastos atuais e status de quota.

Descrição

O endpoint GET /tools/api/list-spending-limits retorna a lista completa de alertas de gastos configurados pelo usuário, incluindo o gasto atual de cada período, percentual utilizado e informações sobre a quota disponível no plano do usuário.

Autenticação

Este endpoint requer autenticação via Bearer token.
string
required
Bearer token com a API key do usuário. Formato: Bearer sk-your-api-key-here

Parâmetros de Query

boolean
required
Se true, retorna também os alertas inativos. Por padrão, retorna apenas alertas ativos (false).
string
required
Parâmetro interno para indicar requisições via MCP. Use s=s para requisições MCP.

Resposta

Sucesso (200)

Erro de Autenticação (401)

Erro de Quota Excedida (403)

Campos da Resposta

boolean
required
Indica se a requisição foi bem-sucedida
array
required
Array com os alertas de gastos configurados
number
required
Número total de alertas retornados
object
required
Informações sobre a quota de alertas do plano do usuário
object
required
Filtros aplicados na requisição
string
required
Timestamp da requisição em formato ISO 8601

Exemplos de Uso

cURL

JavaScript

Python

Códigos de Status

  • 200: Sucesso - Alertas retornados
  • 401: Erro de autenticação ou assinatura
  • 403: Quota excedida (ao tentar criar novos alertas)
  • 500: Erro interno do servidor

Limites por Plano

  • FREE: 3 alertas de gastos
  • PRO: 10 alertas de gastos
  • PREMIUM: 30 alertas de gastos
Os alertas são calculados em tempo real com base nas transações do período especificado. O status é atualizado automaticamente: ok para 0-49%, warning para 50-74%, e danger para 75% ou mais do limite.

Authorizations

Authorization
string
header
required

API key in Bearer token format. Example: Bearer sk-your-api-key-here

Query Parameters

includeInactive
boolean
default:false

Se deve incluir limites inativos na resposta

Response

Lista de limites de gastos

success
boolean
Example:

true

data
any[]
count
number

Número de limites retornados

Example:

3

quota
any
filters
object
timestamp
string<date-time>