AI usage by feature

GET

/ai/usage

curl --request GET \
  --url https://api.sloose.com/ai/usage \
  --header 'Authorization: Bearer <token>'

• Production

Credits and tokens for the period, broken down by feature. Defaults to the current calendar month.

Authorizations

• sessionAuth
• apiTokenAuth

Parameters

Query Parameters

from

ISO start of the range. Defaults to the start of this month.

string

ISO start of the range. Defaults to the start of this month.

to

ISO end of the range, exclusive. Defaults to the start of next month.

string

ISO end of the range, exclusive. Defaults to the start of next month.

Responses

200

Usage for the range.

Media typeapplication/json

Totals and a per-feature breakdown of calls, tokens and credits.

object

key

additional properties

Example^generated

{
  "additionalProperty": "example"
}

400

from or to is not an ISO date.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed values: BAD_INPUT

key

additional properties

Example

{
  "code": "BAD_INPUT"
}

401

No bearer, or one that no longer resolves: a session that is unknown or expired (code: AUTH_REQUIRED), or an API token that was revoked or expired (TOKEN_REVOKED, TOKEN_EXPIRED), whose organisation is gone (ORG_NOT_FOUND) or whose member or user row is (MEMBERSHIP_GONE).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

The bearer’s role is too low (code: ROLE_REQUIRED), or it was issued for a different organisation; the organisation has been closed (code: ORG_CLOSED, either kind of bearer); the person is banned (code: BANNED, a session); or it is a session that is signed in but in no organisation (code: NO_ORG): one that never joined one, or whose person was taken out of the one it was in, or left it. Signing in again changes nothing for NO_ORG; choosing or making an organisation does.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).