Skip to content

Usage API

1 endpoint. Every path is relative to the API base URL and needs a bearer token unless it is marked public. See the REST API overview for authentication, errors and pagination.

GET/v1/orgs/{orgId}/usage

Bearer tokenMCP tool: get_usage

Usage credits, storage, workspaces and seats used this billing month against the plan's allowances. Credits are shared by every workspace on the plan; 1 credit is 1 cent of AI, research, X and video delivery cost.

Path parameters

  • orgIdstring (uuid)required

Responses

200Usage credits, storage, workspaces and seats used this billing month against the plan's allowances. Credits are shared by every workspace on the plan; 1 credit is 1 cent of AI, research, X and video delivery cost.
  • dataobjectrequired
    Fields
    • planKeystringrequired
    • planNamestring | nullrequired
    • periodStartstringrequired
    • periodEndstringrequired
    • statestringrequired

      one of ok, nearly_out, out

    • creditsobjectrequired
      Fields
      • includednumberrequired
      • usednumberrequired
      • remainingnumberrequired
      • usedByThisWorkspacenumberrequired
      • byCategoryarray<object>required
        Item fields
        • categorystringrequired
        • labelstringrequired
        • creditsnumberrequired
    • storageobjectrequired
      Fields
      • usedBytesnumberrequired
      • limitBytesnumberrequired
      • maxVideoUploadBytesnumberrequired
    • workspacesobjectrequired
      Fields
      • usednumberrequired
      • limitnumberrequired
    • seatsobjectrequired
      Fields
      • usednumberrequired
      • limitnumberrequired
Request
curl -X GET "https://api.adventur.ai/v1/orgs/$ORG_ID/usage" \
-H "Authorization: Bearer $ADVENTURAI_TOKEN"