API de Saldo

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

GET/openapi/v1/balance

Obter o saldo

Retorna o saldo de créditos da conta proprietária da chave de API. Em uma equipe com um conjunto de créditos compartilhado, os valores são os do conjunto. 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
}

Retornos

Name
balance
Type
integer
Description
Número de créditos que você pode gastar. Geralmente é monthly_credits mais permanent_credits.
Pode ser menor quando um limite de crédito de membro ou um limite de crédito de espaço de trabalho Enterprise se aplica a você. Proprietários e administradores de equipe 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, de pacotes de créditos que você comprou e de recompensas.
Name
monthly_resets_at
Type
timestamp
Description
Horário da próxima renovação mensal de créditos, em milissegundos Unix. Nesse momento, os créditos mensais restantes expiram e uma assinatura ativa os reabastece. null quando nenhuma renovação está agendada.

Modos de falha

Name
401 - Unauthorized
Description
A chave de API está ausente ou é inválida. Verifique o cabeçalho Authorization.
Name
429 - Too Many Requests
Description
Você enviou muitas solicitações. Aguarde o número de segundos indicado em Retry-After e tente novamente.