Usage

Get Usage

Changed on Feb 8, 2026

get/v1/usage/

Request

Base URL
https://api.aymara.ai
Auth
- API key in header x-api-key
- or HTTP bearer
TypeScript
https://skmtc.dev/aymara-ai/apis/aymara-api/docs/v1/usage/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

workspace_uuidstring nullable

date_fromstring date nullable

Start date for filtering free user score runs

date_tostring date nullable

End date for filtering free user score runs

billing_cycle_uuidstring nullable

Specific billing cycle UUID to retrieve

Response

test_type_displaysobject required

Changes

Feb 8, 20269b529d67a7d0 Revision changes
- breaking
  removed the required property /// from the response with the status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new auth.workspace_required enum value to the / response property for the response status
- warning
  added the new video enum value to the ///// response property for the response status
- info
  added the new optional query request parameter billing_cycle_uuid
- info
  added the new optional query request parameter date_from
- info
  added the new optional query request parameter date_to
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the optional property /// to the response with the status
- info
  added the required property /// to the response with the status
Feb 8, 202639873621da54 Revision changes
- info
  removed the audio enum value from the /////// response property for the response status
- info
  removed the audio enum value from the ///// response property for the response status
- info
  removed the video enum value from the /////// response property for the response status
- info
  removed the video enum value from the ///// response property for the response status

Operation history (3 revisions)

Get Usage

Request

Query parameters

Response 200OK

Changes

Response