Skip to main content
GET
/
api
/
ai
/
usage
Get AI usage records
curl --request GET \
  --url https://api.example.com/api/ai/usage \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "configId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "modelId": "<string>",
    "promptTokens": 123,
    "completionTokens": 123,
    "totalTokens": 123,
    "cost": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "provider": "<string>",
    "model": "<string>",
    "inputModality": [
      "text"
    ],
    "outputModality": [
      "text"
    ]
  }
]

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
startDate
string<date-time>

Start date for usage period

​
endDate
string<date-time>

End date for usage period

​
limit
string
default:50

Number of records to return

​
offset
string
default:0

Number of records to skip

Response

Usage records

​
id
string<uuid>
​
configId
string<uuid>
​
modelId
string
​
promptTokens
integer
​
completionTokens
integer
​
totalTokens
integer
​
cost
number
​
createdAt
string<date-time>
​
provider
string | null
​
model
string | null
​
inputModality
enum<string>[] | null
Available options:
text,
image
​
outputModality
enum<string>[] | null
Available options:
text,
image