NDNCI Docs
API v1API reference

Read usage and budget limits

Return weighted usage counters, reset times, financial budget reservations and stream availability for the selected workspace.

GET/v1/usage

Authorization

bearerKey
AuthorizationBearer <token>

A scoped automation key authorized for the REST API.

In: header

Header Parameters

X-Ndnci-Workspace*string

Select a workspace explicitly included in this access grant.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/usage" \  -H "X-Ndnci-Workspace: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Authorization: Bearer <NDNCI_API_KEY>"
{  "success": true,  "code": "PUBLIC_USAGE_GET",  "message": "Successful response",  "data": {    "workspaceId": "123e4567-e89b-42d3-a456-426614174001",    "plan": "free",    "points": {      "minuteLimit": 240,      "minuteUsed": 2,      "minuteResetsAt": "2026-10-01T12:01:00Z",      "monthlyLimit": 10000,      "monthlyUsed": 100,      "monthlyResetsAt": "2026-11-01T00:00:00Z"    },    "budgets": [      {        "scope": "key",        "period": "day",        "limitMillicents": 100000,        "spentMillicents": 1000,        "reservedMillicents": 1000,        "resetsAt": "2026-10-02T00:00:00Z"      }    ],    "streams": {      "enabled": false,      "maximum": 0    }  }}

Required scope: usage:read · Usage points: 1

Credits are charged separately for work that consumes paid services.

Follow job updates GET

Receive bounded server-sent job updates for one authorized workspace job. Available with Pro; reconnect and read the job when an event gap is detected.

Read workspace events GET

Read a bounded event page for the selected workspace. Persist the returned cursor only after processing each event successfully; events never grant access outside the approved workspace.