Nurama Developers
AI

Aggregated Nurama Credit usage report for a workspace.

Credit spend on AI features (and convos) in a time window, totalled and broken down by user and by integration point. Defaults to a rolling 30-day window ending now when no dates are passed. Filters apply uniformly: `userId` narrows the per-integration breakdown to that user's calls, and `integrationPoint` narrows the per-user breakdown to that feature. Requires `canGetCreditUsageReport` on the workspace (granted to the same roles as `canGetCreditBalance`) and an active subscription. Also available at `GET /credits/usage` (same response).

GET
/ai/usage

Credit spend on AI features (and convos) in a time window, totalled and broken down by user and by integration point. Defaults to a rolling 30-day window ending now when no dates are passed. Filters apply uniformly: userId narrows the per-integration breakdown to that user's calls, and integrationPoint narrows the per-user breakdown to that feature.

Requires canGetCreditUsageReport on the workspace (granted to the same roles as canGetCreditBalance) and an active subscription.

Also available at GET /credits/usage (same response).

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

workspaceId*string
Formatuuid
startDate?string

ISO 8601 date-time. Defaults to 30 days before endDate.

Formatdate-time
endDate?string

ISO 8601 date-time; must not be before startDate. Defaults to now.

Formatdate-time
userId?string
Formatuuid
integrationPoint?string

Value in

  • "polish"
  • "chat"
  • "taskGeneration"
  • "imageRevision"
  • "convo"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/ai/usage?workspaceId=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "total": {    "billedCredits": 0,    "callCount": 0,    "tokensIn": 0,    "tokensOut": 0  },  "byUser": [    {      "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",      "displayName": "string",      "avatar": null,      "billedCredits": 0,      "callCount": 0    }  ],  "byIntegration": [    {      "integrationPoint": "polish",      "billedCredits": 0,      "callCount": 0    }  ],  "filters": {    "startDate": "2019-08-24T14:15:22Z",    "endDate": "2019-08-24T14:15:22Z",    "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",    "integrationPoint": "string"  }}