Usage API Reference
Deepgram's Usage API gives you access to your account's usage statistics for Deepgram services.
Endpoint
https://usage.deepgram.com/beta
Authentication
All requests to the API should include a basic
Authorization
header that references the Base64-encoded username (or email address
you used to sign up) and password of your Deepgram account.
For example, for user gandalf
with password
mellon
, the base64-encoded value of
gandalf:mellon
is Z2FuZGFsZjptZWxsb24=
. So
Gandalf's requests to the Deepgram API should all include the
following header:
Authorization: Basic Z2FuZGFsZjptZWxsb24=
.
Security Scheme Type | HTTP |
---|---|
HTTP Authorization Scheme | basic |
Usage
Get usage statistics for Deepgram services.
Get Usage
Gets usage statistics for Deepgram services.
Query Parameters
Date for which you want to get usage statistics. Format is YYYY-MM-DD. If not specified, you will receive statistics for all-time usage.
Default: null
Possible Values: null or <YYYY-MM-DD>
Responses
Status | Description |
---|---|
200 Success | Usage statistics found. |
Response Schema
result: array
Array of JSON-formatted objects.
account: string
Unique identifier for your account (usually an email address).
usage: Object
Date/time when request was created.
since: string
Start date of retrieved usage statistics
until: string
End date of retrieved usage statistics.
models: array
Array of JSON-formatted model objects.
model: string
Name of off-the-shelf model or
custom_id
of custom model.language: string
BCP-47 language tag.
values: Object
Object containing the values of the statistics for a given model/language combination.
batch_total_count: integer
Number of files processed using Deepgram's batch audio. For hosted services only.
batch_total_hr: integer
Length of time (in hours) of batch audio processing. For hosted services only.
batch_diarize_count: integer
Number of files processed through batch audio using Deepgram's diarization feature. For hosted services only.
batch_diarize_hr: integer
Length of time (in hours) of batch audio processing using Deepgram's diarization feature. For hosted services only.
stream_total_count: integer
Number of files processed using Deepgram's streaming audio. For hosted services only.
stream_total_hr: integer
Length of time (in hours) of streaming audio processing. For hosted services only.
stream_diarize_count: integer
Number of files processed through streaming audio using Deepgram's diarization feature. For hosted services only.
stream_diarize_hr: integer
Length of time (in hours) of streaming audio processing using Deepgram's diarization feature. For hosted services only.
onprem_total_hr: integer
Length of time (in hours) of on-prem audio processing.