CognitiveX Docs
API

GET /api/circles/{circle_id}/budget/usage

Get Budget Usage

GET /api/circles/{circle_id}/budget/usage

Get Budget Usage

Authentication: Authorization: Bearer <key> or X-API-Key: <key>. Create keys at developers.cognitivx.io/keys.

Parameters

NameInTypeRequiredDescription
circle_idpathstringYes-
X-Org-IDheaderstring | nullNo-

Example request

curl -X GET https://api.cognitivx.io/api/circles/{circle_id}/budget/usage \
  -H "Authorization: Bearer icog_..."

Example response

200 application/json

[
  {
    "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "username": "production",
    "display_name": "production",
    "message_count": 10,
    "memory_write_count": 10
  }
]

Responses

StatusDescription
200Success. Returns the response body shown below.
422Request validation failed. detail lists each offending field.