Skip to content
Docs
Select language:English

/api/v1/ai/usage

GET
/api/v1/ai/usage
curl --request GET \
  --url 'https://example.com/api/v1/ai/usage?scope=me&groupBy=day'

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
scope
string
default: me
Allowed values: me location account instance
locationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
from
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
to
Any of:
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
groupBy
string
default: day
Allowed values: day task model person location account

Responses

Section titled “Responses”

200

Section titled “200”

Default Response

Media typeapplication/json
object
scope
required
string
Allowed values: me location account instance
from
required
string
to
required
string
soFar
required
boolean
groups
required
Array<object>
object
calls
required
number
sentCalls
required
number
tokens
required
object
input
required
number
output
required
number
reasoning
required
number
cached
required
number
images
required
number
cost
required
Array<object>
object
currency
required
string
amount
required
string
unknownCostCalls
required
number
outcomes
required
object
key
additional properties
number
tasks
object
key
additional properties
object
calls
required
number
tokens
required
number
key
required
string
label
required
string
totals
required
object
calls
required
number
sentCalls
required
number
tokens
required
object
input
required
number
output
required
number
reasoning
required
number
cached
required
number
images
required
number
cost
required
Array<object>
object
currency
required
string
amount
required
string
unknownCostCalls
required
number
outcomes
required
object
key
additional properties
number
tasks
object
key
additional properties
object
calls
required
number
tokens
required
number
caps
required
Array<object>
object
id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
scope
required
string
Allowed values: instance instance_account account location member user
target
required
object
id
required
string | null
label
required
string
task
required
Any of:
string
Allowed values: extraction assistant embeddings
tokensPerMinute
number
tokensPerDay
number
tokensPerMonth
number
monthlyCap
object
amount
required
string
currency
required
string
used
required
object
tokens
required
number
cost
required
Array<object>
object
currency
required
string
amount
required
string
unknownCostCalls
required
number
notCounted
required
Array<string>
percent
required
number | null
state
required
string
Allowed values: active warned paused
pausedUntil
string
reason
string
Allowed values: manual cap_money cap_tokens tokens_day
cappedByAccount
required
boolean
rowVersion
required
number
canEdit
required
boolean
Example
{
  "scope": "me",
  "caps": [
    {
      "scope": "instance",
      "task": "extraction",
      "state": "active",
      "reason": "manual"
    }
  ]
}