For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Retrieves the usage breakdown for a specific project, with various filter options by API feature or by groupings. Setting a feature (e.g. diarize) to true includes requests that used that feature, while false excludes requests that used it. Multiple true filters are combined with OR logic, while false filters use AND logic.
Authentication
AuthorizationToken
Use Authorization: Token <API_KEY>
Example: Authorization: Token 12345abcdef
Path parameters
project_idstringRequired
Query parameters
startstringOptionalformat: "date"
Start date of the requested date range. Format accepted is YYYY-MM-DD
endstringOptionalformat: "date"
End date of the requested date range. Format accepted is YYYY-MM-DD
groupingenumOptional
Common usage grouping parameters
accessorstringOptional
Filter for requests where a specific accessor was used
alternativesbooleanOptional
Filter for requests where alternatives were used
callback_methodbooleanOptional
Filter for requests where callback method was used
callbackbooleanOptional
Filter for requests where callback was used
channelsbooleanOptional
Filter for requests where channels were used
custom_intent_modebooleanOptional
Filter for requests where custom intent mode was used
custom_intentbooleanOptional
Filter for requests where custom intent was used
custom_topic_modebooleanOptional
Filter for requests where custom topic mode was used
custom_topicbooleanOptional
Filter for requests where custom topic was used
deploymentenumOptional
Filter for requests where a specific deployment was used
Allowed values:
detect_entitiesbooleanOptional
Filter for requests where detect entities was used
detect_languagebooleanOptional
Filter for requests where detect language was used
diarizebooleanOptional
Filter for requests where diarize was used
dictationbooleanOptional
Filter for requests where dictation was used
encodingbooleanOptional
Filter for requests where encoding was used
endpointenumOptional
Filter for requests where a specific endpoint was used
Allowed values:
extrabooleanOptional
Filter for requests where extra was used
filler_wordsbooleanOptional
Filter for requests where filler words was used
intentsbooleanOptional
Filter for requests where intents was used
keytermbooleanOptional
Filter for requests where keyterm was used
keywordsbooleanOptional
Filter for requests where keywords was used
languagebooleanOptional
Filter for requests where language was used
measurementsbooleanOptional
Filter for requests where measurements were used
methodenumOptional
Filter for requests where a specific method was used
Allowed values:
modelstringOptional
Filter for requests where a specific model uuid was used
multichannelbooleanOptional
Filter for requests where multichannel was used
numeralsbooleanOptional
Filter for requests where numerals were used
paragraphsbooleanOptional
Filter for requests where paragraphs were used
profanity_filterbooleanOptional
Filter for requests where profanity filter was used
