All docs Nebula docs All endpoints Interactive docs Markdown OpenAPI JSON
  1. REST API
  2. Account

Account

GET /account
GetAccount

Your plan, history window, rate limit, and credits left this cycle. Free to call. The same figures come back on every response as the RateLimit-* and X-Credits-* headers.

Wallet payment is not available for this operation; use account authentication. x402 payment guide.

Parameters

No parameters for this endpoint.

cURL Example

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

Responses

200 OK
400 Bad Request
401 Unauthorized
402 Credits used up; response includes renewal timing and purchased credit balance
403 Forbidden
404 Not Found
405 Method not allowed; the Allow header lists the supported method
429 Too Many Requests
500 Internal Server Error
503 Service Unavailable

Media type application/json

credits
object optional

The account's credit position this cycle; absent for keys that are not metered.
credits.cycle_end
string (date-time) required

UTC end of the current credit cycle, when plan credits renew.

credits.cycle_start
string (date-time) required

UTC start of the current credit cycle.

credits.plan_credits
integer (int64) required

Credits the plan includes this cycle.

credits.plan_credits_remaining
integer (int64) required

Plan credits left this cycle.

credits.plan_credits_used
integer (int64) required

Plan credits spent this cycle.

credits.purchased_credits_remaining
integer (int64) required

Unexpired purchased credits left, spent after plan credits.

credits.total_remaining
integer (int64) required

Everything left to spend: plan plus purchased credits.

history_window_days
integer required

How many days back the plan can read; null when unbounded.

plan
string required

The account's API plan, such as free or pro.

rate_limit_per_minute
integer required

Requests allowed per minute; null when the key is not rate limited.

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