usage

Get Usage

The account's credit balance, and what it has spent, per model.

Account-wide rather than per key, because that is what the balance belongs to. A job is charged when it succeeds, so work still queued or running is not in these figures yet, and a job that fails costs nothing. The balance here is the one your next submission is judged by.

get/v1/usage

Request

  • Base URL: https://api.craterview.ai
  • URL: https://api.craterview.ai/v1/usage
  • Auth: HTTP bearer

Response

Successful Response

creditsinteger required

Credits spent, all time.

credits_grantedinteger required

Credits added to this account, all time — bought, granted, and arrears written off — less any refunded purchase.

credits_remaininginteger required

Credits left to spend. Never below zero: work on the community queue is charged and may take an account past its balance, and the arrears are written off the next time credit arrives.

subscribed_untilstring date-time nullable

When the current subscription's paid period ends, ISO-8601 — null when there is no subscription. Informational: subscribed is the answer to which queue your work enters, decided here rather than by comparing this against your own clock.

subscribedboolean

Whether a subscription is currently putting this account's work on paid compute. While it is true, work runs there at any balance — and the balance means what it always did, because a subscription grants no credit and jobs are charged as usual. A capped subscription gives it for subscription_allowance credits of work a period; past that, work runs on the community queue until the period renews.

subscription_allowanceinteger nullable

How many credits of work a period the subscription puts on paid compute, or null for one with no cap and when there is no subscription. Nothing is granted: jobs are charged as usual, and the window holds until the period's charges reach this figure.

subscription_allowance_remaininginteger nullable

Under a capped subscription, how much of subscription_allowance is left this period: how many more credits of work it will put on paid compute. Credit on the account is counted separately, as credits_remaining, and is spent first. Null where there is no cap.

is_guestboolean

Whether this account has no sign-in attached to it. An account created in a browser or on a device starts this way and works normally — it submits, it spends credit, it holds keys. What it cannot do is buy or publish, and it cannot be reached from anywhere else, because there is nothing to sign in with. Signing in attaches one and this becomes false, keeping the same account, keys and history.

jobsinteger required

Jobs submitted, all time, whatever their outcome.

output_bytesinteger required

Total size of the results produced, in bytes — the results only, not the input or the preview kept beside them.

jobs_in_flightinteger

Your jobs queued or running right now.

max_jobs_in_flightinteger required

The most you may have queued or running at once. Submitting past it is refused with a 429. It is higher once the account is signed in, so read it rather than assuming it.

Changes

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