For AI agents: a documentation index is available at /llms.txt. Markdown versions of all pages can be requested by appending `.md` to the URL, or by setting the `Accept` header to `text/markdown`.
Skip to main content
Administration

Usage

Track transcription usage by processing mode and model in the portal and through the API.

Usage reporting in the portal covers cloud usage only. On-prem deployments report usage differently. See on-prem usage reporting.

View usage in the portal​

  1. Go to Usage in the sidebar under Workspace.
  2. Select a time range, such as 7D, 30D, or Custom.
  3. Use the All projects dropdown to view usage for a single project or across the workspace.

Usage is shown in two charts, Realtime and Batch, matching the processing mode of each request. Each chart breaks usage down by model and reports total time used and request count.

Usage by model​

The models shown depend on the processing mode:

  • Realtime: Standard and Enhanced.
  • Batch: Standard, Enhanced, and Melia 1.

Usage on the medical domain and on agent STT is reported under the underlying model, not as a separate line. For example, Batch usage with the medical domain appears under Enhanced.

Track usage with the API​

To retrieve usage data programmatically, use the Usage API. Usage is reported as the number of jobs successfully processed in a time period, along with the total duration of the corresponding audio files.

The Usage API currently reports Batch usage only.

Usage is queried with an API key, and is returned for the account associated with that key. All usage is reported on a Coordinated Universal Time (UTC) calendar day basis, and usage for the current UTC day is not included in the results. Deleting a completed job has no effect on reported usage.

Request usage​

This request retrieves usage for all jobs from the beginning of 1 January 2023 until the end of 31 December 2023. More precisely, it includes all jobs completed successfully at or after 2023-01-01T00:00Z and before 2024-01-01T00:00Z.

The since and until parameters are both optional:

  • If since is omitted, usage is reported from the day on which the first job was successfully processed for the account.
  • If until is omitted, usage is reported until the end of the previous UTC day.
curl -L -X GET "https://eu1.asr.api.speechmatics.com/v2/usage?since=2023-01-01&until=2023-12-31" \
    -H "Authorization: Bearer $API_KEY"

Response​

The response is a JSON object containing usage information. See Get usage statistics in the API reference for full details.

Next steps​

  • Billing: understand how usage translates into charges.
  • Projects: organize work to track usage separately.