account

Check whether this API key can make billable calls

One-call self-diagnosis for the presented key: whether billable endpoints will serve it, and if not why (blocked_reason) and for how long (retry_after). Works even when the key is blocked. The same handler is exposed on POST (sapling_account_status_post). Team-scoped keys receive only the verdict and their own quota.

get/api/v1/account/status

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/account/status
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter key

Query parameters

return_usageboolean

When true, a successful JSON-object response additionally carries "usage": {"characters": <n>} — the billable character count this request submitted (0 for unbilled requests; the 2.5x adjustment for logographic languages is included, so CJK requests report more than their raw length). Repeat texts inside the billing deduplication window are still counted here even though they are not re-charged, so the number is an upper bound on the final charge. Responses whose body is not a JSON object (e.g. bare-array response formats) cannot carry the field. An existing usage field (such as account/status or completion token usage) is preserved unchanged.

Response

Access verdict plus credit, subscription, usage and trial details.

api_accessboolean
blocked_reasonunknown
creditsobject
messageunknown
retry_afterinteger

Seconds until the block may clear. Present only when blocked.

subscriptionobject
trialobject
usageobject

Changes

No recorded changes to this operation across all 1 revision of this API.