Usage

Get usage & cost

Changed on

Report billable usage and cost for the organization over a time window, broken down by project (highest spend first). Pass from/to as ISO 8601 timestamps; optionally pass projectId to scope the report to one project. Amounts are billable spend only (what we absorb is never included). Authenticated by either an organization API key with the usage:read permission (any project in the organization), or a project API key with the billing:read permission (that key's own project only; any other projectId is a 403).

get/v1/usage

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/usage
  • Auth
    HTTP bearer

Query parameters

fromstring date-time required

Start of the window (inclusive), ISO 8601.

Example:2026-09-01T00:00:00Z
tostring date-time required

End of the window (exclusive), ISO 8601. Must be after from, and the window may not exceed 366 days.

Example:2026-10-01T00:00:00Z
projectIdstring uuid

Limit the report to a single project. Omit for the whole organization.

Response

The usage & cost report for the window

Changes

    • warning

      added the new PHONE_NUMBER enum value to the ///// response property for the response status

    • info

      added the required property /// to the response with the status