Pular para o conteúdo principal
POST
Criar uma regra de gastos
Requer spend_rules:write. Chamadores OAuth precisam ser proprietários ou administradores do espaço de trabalho. Envie cada valor em USD (*_usd) ou em nanodólares (*_nanos), não ambos. Um espaço de trabalho pode ter 50 regras de gastos. Veja o guia de alertas de gastos para as métricas, bases, escopos e períodos.

Autorizações

Authorization
string
header
obrigatório

Autenticação com token Bearer

Corpo

application/json

Uma regra de gastos a criar. name, metric e period são obrigatórios. Regras spike usam por padrão um multiplicador de 3x e um piso de US$ 5.

name
string
obrigatório
Required string length: 1 - 100
metric
enum<string>
obrigatório

spend: o gasto atingiu threshold_amount. budget_percent: o gasto atingiu threshold_percents da base. forecast: o gasto projetado para o fim do período atinge o limite. spike: o gasto nas últimas window_hours é pelo menos spike_multiplier vezes a mediana da mesma janela nos 7 dias anteriores, e pelo menos spike_floor. balance: o saldo ou a autonomia do workspace fica abaixo do limite.

Opções disponíveis:
spend,
budget_percent,
forecast,
spike,
balance
period
enum<string>
obrigatório

day, week (a partir de segunda-feira) ou month no fuso horário da regra, ou rolling nas últimas window_hours.

Opções disponíveis:
day,
week,
month,
rolling
enabled
boolean
scope_type
enum<string>
Opções disponíveis:
workspace,
key,
member,
department,
model,
provider
scope_id
string | null

Null para o escopo do workspace; caso contrário, o ID de uma chave, o ID de usuário de um membro, o ID de um departamento, o ID de um modelo ou o ID de um provedor.

Maximum string length: 200
window_hours
integer | null

Horas de uma janela rolling: a janela de pico para regras spike (no máximo 56, para que caibam 3 janelas nos 7 dias anteriores) e o período de consumo para regras balance. Nulo para períodos de calendário.

Intervalo obrigatório: 1 <= x <= 720
time_zone
string | null

Fuso horário IANA dos períodos de calendário. Null usa o fuso horário de cobrança do workspace.

Maximum string length: 64
base_kind
enum<string> | null

Do que threshold_percents são porcentagens: amount (base_amount), workspace_budget ou key_limit (o intervalo base_ref, que deve corresponder ao período) ou previous_period.

Opções disponíveis:
amount,
workspace_budget,
key_limit,
previous_period
base_ref
enum<string> | null
Opções disponíveis:
daily,
weekly,
monthly
base_amount_usd
number | null
base_amount_nanos
integer<int64> | null
threshold_percents
integer[] | null

Até cinco porcentagens inteiras da base, ordenadas. Cada uma dispara no máximo uma vez por período; se várias forem cruzadas ao mesmo tempo, um único alerta é enviado com a mais alta.

Required array length: 1 - 5 elements
Intervalo obrigatório: 1 <= x <= 1000
threshold_amount_usd
number | null
threshold_amount_nanos
integer<int64> | null
runway_days
integer | null
Intervalo obrigatório: 1 <= x <= 365
spike_multiplier
number | null
spike_floor_usd
number | null
spike_floor_nanos
integer<int64> | null
action
enum<string>

notify, ou avisar e depois bloquear quando o gasto atingir block_at_percent da base ou block_at_amount. O bloqueio é feito com o melhor esforço e age minutos após o limite. Enquanto o bloqueio estiver desativado no gateway, uma regra que começaria a bloquear é recusada com um 400, e uma regra que já bloqueia apenas avisa.

Opções disponíveis:
notify,
block
block_at_percent
integer
Intervalo obrigatório: 100 <= x <= 1000
block_at_amount_usd
number | null
block_at_amount_nanos
integer<int64> | null
block_free_models
boolean

Se um bloqueio também interrompe solicitações a modelos gratuitos.

cooldown_minutes
integer

Mínimo de minutos entre alertas nas regras rolling, spike e balance.

Intervalo obrigatório: 5 <= x <= 43200
destination_ids
string<uuid>[]

Destinos de notificação dos alertas desta regra. Vazio significa a rota de Spend Alerts do workspace.

Maximum array length: 50

Resposta

Regra de gastos criada

data
object
obrigatório

Uma regra de gastos: limites em dólares ou em porcentagem para um escopo e um período que avisam, ou avisam e depois bloqueiam. Os valores são retornados em nanodólares e em USD.

Última modificação em 31 de outubro de 2026