getApiV1UsageByModality

getApiV1UsageByModality<ThrowOnError>(options?: Options<GetApiV1UsageByModalityData, ThrowOnError>): RequestResult<GetApiV1UsageByModalityResponses, GetApiV1UsageByModalityErrors, ThrowOnError>

Defined in: src/client/sdk.gen.ts:1581

Get usage by modality

Returns usage grouped into the four user-facing modality buckets (text, image, video, audio) for the authenticated user within a time period. Tool spend is attributed to the bucket of the calling model. Unknown models default to text.

Type Parameters

Type Parameter	Default type
`ThrowOnError` extends `boolean`	`false`

Parameters

Parameter	Type
`options?`	`Options`<`GetApiV1UsageByModalityData`, `ThrowOnError`>

Returns

RequestResult<GetApiV1UsageByModalityResponses, GetApiV1UsageByModalityErrors, ThrowOnError>