API de Saldo

Verifique quantos créditos pode gastar e quantos deles expiram na próxima renovação mensal.

GET/openapi/v1/balance

Obter o saldo

Devolve o saldo de créditos da conta à qual pertence a chave de API. Numa equipa com um conjunto partilhado de créditos, os valores são os do conjunto partilhado. Chamar este endpoint é gratuito.

Request

GET

/openapi/v1/balance

curl https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"

Response

{
  "balance": 1000,
  "monthly_credits": 600,
  "permanent_credits": 400,
  "monthly_resets_at": 1793491200000
}

Devolve

Name
balance
Type
integer
Description
Número de créditos que pode gastar. É normalmente monthly_credits mais permanent_credits.
Pode ser inferior quando se aplica um limite de créditos de membro ou um limite de créditos de espaço de trabalho Enterprise. Os proprietários e administradores de equipa não têm esse limite.
Name
monthly_credits
Type
integer
Description
Número de créditos restantes que expiram na próxima renovação mensal, em monthly_resets_at.
Name
permanent_credits
Type
integer
Description
Número de créditos que não expiram, por exemplo, provenientes de pacotes de créditos que comprou e de recompensas.
Name
monthly_resets_at
Type
timestamp
Description
Momento da próxima renovação mensal de créditos, em milissegundos Unix. Nesse momento, os créditos mensais restantes expiram, e uma subscrição ativa renova-os. null quando não está agendada nenhuma renovação.

Modos de falha

Name
401 - Unauthorized
Description
A chave de API está em falta ou é inválida. Verifique o cabeçalho Authorization.
Name
429 - Too Many Requests
Description
Enviou demasiados pedidos. Aguarde o número de segundos indicado em Retry-After e, em seguida, tente novamente.