Skip to content
rowlab Docs

Get Usage

GET
/v1/settings/usage
curl --request GET \
  --url https://example.com/v1/settings/usage \
  --header 'Authorization: Bearer <token>'

A month’s answers, spend and tokens (this month by default, as YYYY-MM), by day, model and person, and the storage the organisation’s datasets take. An admin sees the organisation’s; anyone else their own runs’.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
month
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Usage
object
month
required
Month

E.g. 2026-11.

string
scope
required
Scope

An admin sees the organisation’s usage; anyone else their own.

string
Allowed values: organisation you
total
required
Total
object
answers
required
Answers

Answers given, from the cache too.

integer
cached
required
Cached

Of those, from the cache, for free.

integer
failed
required
Failed
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
cost
required
Cost

USD.

number
by_day
required
By Day

Days with usage, in order.

Array<object>
Day
object
answers
required
Answers

Answers given, from the cache too.

integer
cached
required
Cached

Of those, from the cache, for free.

integer
failed
required
Failed
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
cost
required
Cost

USD.

number
day
required
Day

E.g. 2026-11-07, in UTC.

string
by_model
required
By Model

Most answers first.

Array<object>
ByModel
object
answers
required
Answers

Answers given, from the cache too.

integer
cached
required
Cached

Of those, from the cache, for free.

integer
failed
required
Failed
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
cost
required
Cost

USD.

number
model
required
Model
string
by_person
required
By Person

Most answers first; the organisation’s only.

Array<object>
ByPerson
object
answers
required
Answers

Answers given, from the cache too.

integer
cached
required
Cached

Of those, from the cache, for free.

integer
failed
required
Failed
integer
input_tokens
required
Input Tokens
integer
output_tokens
required
Output Tokens
integer
cost
required
Cost

USD.

number
user
required
Any of:
User
object
id
required
Id
string
email
required
Email
string
name
required
Name
string
storage_bytes
required
Storage Bytes

The organisation’s datasets, now.

integer

Example 

{
  "scope": "organisation"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Example generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}