Вся документация Документация Nebula Все эндпоинты Интерактивная документация Markdown OpenAPI JSON
  1. REST API
  2. Аккаунт

Аккаунт

GET /account
GetAccount

Ваш план, окно истории, лимит запросов и оставшиеся кредиты в текущем цикле. Вызов бесплатный. Те же значения возвращаются в каждом ответе в заголовках RateLimit-* и X-Credits-*.

Оплата кошельком недоступна для этой операции; используйте аутентификацию аккаунта. Руководство по оплате x402.

Параметры

У этого эндпоинта нет параметров.

Пример cURL

curl --request GET \
  --url 'https://nebula-api.hiddensystems.ai/api/v1/public/account' \
  --header 'X-API-Key: YOUR_API_KEY'

Ответы

200 OK
400 Некорректный запрос
401 Не авторизован
402 Кредиты израсходованы; ответ содержит срок продления и баланс купленных кредитов
403 Доступ запрещён
404 Не найдено
405 Метод не поддерживается; поддерживаемые методы перечислены в заголовке Allow
429 Слишком много запросов
500 Внутренняя ошибка сервера
503 Сервис недоступен

Тип медиа application/json

credits
object необязательный

Кредитная позиция аккаунта в текущем цикле; отсутствует для ключей без тарификации.
credits.cycle_end
string (date-time) обязательный

Окончание текущего кредитного цикла в UTC, когда обновляются кредиты плана.

credits.cycle_start
string (date-time) обязательный

Начало текущего кредитного цикла в UTC.

credits.plan_credits
integer (int64) обязательный

Кредиты, включённые в план на этот цикл.

credits.plan_credits_remaining
integer (int64) обязательный

Оставшиеся кредиты плана в этом цикле.

credits.plan_credits_used
integer (int64) обязательный

Израсходованные кредиты плана в этом цикле.

credits.purchased_credits_remaining
integer (int64) обязательный

Оставшиеся непросроченные купленные кредиты; расходуются после кредитов плана.

credits.total_remaining
integer (int64) обязательный

Всё, что осталось потратить: кредиты плана плюс купленные кредиты.

history_window_days
integer обязательный

На сколько дней назад план может читать данные; null, если ограничение отсутствует.

plan
string обязательный

API-план аккаунта, например free или pro.

rate_limit_per_minute
integer обязательный

Разрешённое число запросов в минуту; null, если для ключа нет ограничения.

{
  "history_window_days": 3650,
  "plan": "pro",
  "rate_limit_per_minute": 300
}