docs
Dashboard API

Dashboard API

Markdown

Dashboard methods: sign-in, profile, keys, and spending history.

Full guide

URLs and authentication

  • Dashboard: https://ailoot.ai (sign-in credentials, Dashboard token)
  • Model API: https://api.ailoot.ai (sk-… key)
ItemURLAuthentication
Dashboard APIhttps://ailoot.ai/api/v1Authorization: Bearer $TOKEN — the Dashboard token obtained after sign-in
Model APIhttps://api.ailoot.ai/v1Key sk-… from the API keys section; see API keys and base URL

Key sk-… does not replace a Dashboard token, and a Dashboard token does not grant access to the model API. Each method lists its full path.

Read your profile
curl --fail-with-body "https://ailoot.ai/api/v1/user/profile" \
  -H "Authorization: Bearer $TOKEN"

Response format and errors

The response contains code, message, and data. Errors may also contain reason and metadata. Pagination in data includes items, total, page, page_size, and pages. Individual methods describe their response formats.

Paginated response structure
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [],
    "total": 0,
    "page": 1,
    "page_size": 20,
    "pages": 1
  }
}

The Dashboard token is checked for expiry and whether the user is active. If session binding is enabled, the IP address and browser are also checked. TOKEN_EXPIRED, TOKEN_REVOKED, USER_INACTIVE, INVALID_TOKEN, and FORBIDDEN distinguish session and permission issues. Rate limits and additional 2FA verification may block an individual request.

How to use this reference

  • Each entry includes the HTTP method, full path, access requirements, parameters, body fields, and response.
  • Take identifiers from a previous response: KEY_ID from GET /api/v1/keys, and the request ID from GET /api/v1/usage.
  • Object fields and their types are listed on the Data schemas pages.
  • Templates show field names and types. PLACEHOLDER and TOKEN are placeholders; they contain no real data.
  • Add funds in the Dashboard’s Pricing section: how to add funds.

Balance and frozen_balance

The profile contains balance and frozen_balance. frozen_balance is the amount reserved for unfinished requests. Check both fields together with your history.

Keys and limits

GET /api/v1/keys returns your keys. The fields quota and quota_used represent the key’s spending limit and the amount already used; ip_whitelist, ip_blacklist, status and expires_at control how the key can be used; rate_limit_5h, rate_limit_1d and rate_limit_7d represent limits for spending windows.

List keys and retrieve your own key
curl --fail-with-body "https://ailoot.ai/api/v1/keys" \
  -H "Authorization: Bearer $TOKEN"

# KEY_ID is the id of your own key from the list response
curl --fail-with-body "https://ailoot.ai/api/v1/keys/$KEY_ID" \
  -H "Authorization: Bearer $TOKEN"

Spending and security

History and the Dashboard show actual_cost, the actual charge, and total_cost, the cost at the standard rate. Date, model, key, and request-type filters are listed for each method. Password changes, TOTP, and passkeys require the confirmations described for their respective methods.

In this section: 39 methods.

Still have questions? Send your Request ID and a description — we'll help you troubleshoot.Contact support