Error
A valid request URL is required to generate request examples{
"results": {
"activeHolds": [
{
"releasedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"placedAt": "2023-11-07T05:31:56Z",
"placedBy": "<string>",
"notes": "<string>",
"reason": "allowance_exhausted",
"contractUuid": "<string>",
"userUuid": "<string>",
"organizationUuid": "<string>",
"uuid": "<string>"
}
],
"byKeyOrigin": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byChannel": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byTier": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byFeature": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"unpricedTokens": 123,
"excluded": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"selfManaged": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"billable": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"canShowCredits": true,
"contract": {
"uuid": "<string>",
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"resetIntervalMonths": 123,
"allowanceCredits": 123
},
"period": {
"periodEnd": "2023-11-07T05:31:56Z",
"periodStart": "2023-11-07T05:31:56Z"
}
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}API Reference
Get AI credit usage
The organization’s AI usage for the current period, in tokens and credits, with its allowance when one is agreed. Organization admins only.
GET
/
api
/
v1
/
org
/
ai-credits
/
usage
Error
A valid request URL is required to generate request examples{
"results": {
"activeHolds": [
{
"releasedAt": "2023-11-07T05:31:56Z",
"expiresAt": "2023-11-07T05:31:56Z",
"placedAt": "2023-11-07T05:31:56Z",
"placedBy": "<string>",
"notes": "<string>",
"reason": "allowance_exhausted",
"contractUuid": "<string>",
"userUuid": "<string>",
"organizationUuid": "<string>",
"uuid": "<string>"
}
],
"byKeyOrigin": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byChannel": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byTier": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"byFeature": [
{
"calls": 123,
"tokens": 123,
"credits": 123,
"key": "<string>"
}
],
"unpricedTokens": 123,
"excluded": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"selfManaged": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"billable": {
"calls": 123,
"tokens": 123,
"credits": 123
},
"canShowCredits": true,
"contract": {
"uuid": "<string>",
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"resetIntervalMonths": 123,
"allowanceCredits": 123
},
"period": {
"periodEnd": "2023-11-07T05:31:56Z",
"periodStart": "2023-11-07T05:31:56Z"
}
},
"status": "ok"
}{
"error": {
"name": "<string>",
"statusCode": 123,
"data": "<unknown>",
"message": "<string>"
},
"status": "error"
}Was this page helpful?