Model Metadata
The Models endpoint allows users to efficiently query all available public models or private models and determine which models they have access to.
Enable Feature
Section titled “Enable Feature”GET /models
Section titled “GET /models”Returns metadata on all the latest public models. If multiple versions exist, the latest model version is returned. If you wish to return all models you can use the include_outdated=true parameter in your request.`
Request
Section titled “Request”curl --location 'https://api.deepgram.com/v1/models' \Result
Section titled “Result”{
"stt": [
{
"name": "general",
"canonical_name": "nova-3-general",
"architecture": "nova3",
"languages": [
"en",
"en-US"
],
"version": "2025-01-09.0",
"uuid": "bf05427e-a1f1-4ced-a976-38b2f3533d8d",
"batch": false,
"streaming": true,
"formatted_output": false
},
// ... other STT models
],
"tts": [
{
"name": "angus",
"canonical_name": "aura-angus-en",
"architecture": "aura",
"languages": [
"en",
"en-IE"
],
"version": "2024-11-19.0",
"uuid": "b50880e3-4e2e-4e53-ba27-ea0472bf2cf4",
"metadata": {
"accent": "Irish",
"color": "#BA80F5",
"image": "https://static.deepgram.com/examples/avatars/angus.jpg",
"sample": "https://static.deepgram.com/examples/voices/angus.wav",
"tags": [
"masculine"
]
}
},
// ... other TTS models
]
}GET /projects//models
Section titled “GET /projects//models”Returns metadata on all the latest models that a specific project has access to, including non-public models. If multiple versions exist, the latest model version is returned. If you wish to return all models you can use the include_outdated=true parameter in your request.
Request
Section titled “Request”curl --location 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/models' \
--header 'Authorization: Token YOUR_DEEPGRAM_API_KEY'Result
Section titled “Result”{
"stt": [
{
"name": "general",
"canonical_name": "nova-3-general",
"architecture": "nova3",
"languages": [
"en",
"en-US"
],
"version": "2025-01-09.0",
"uuid": "bf05427e-a1f1-4ced-a976-38b2f3533d8d",
"batch": false,
"streaming": true,
"formatted_output": false
},
... additional STT Models.
],
"tts": [
{
"name": "angus",
"canonical_name": "aura-angus-en",
"architecture": "aura",
"languages": [
"en",
"en-IE"
],
"version": "2024-11-19.0",
"uuid": "b50880e3-4e2e-4e53-ba27-ea0472bf2cf4",
"metadata": {
"accent": "Irish",
"color": "#BA80F5",
"image": "https://static.deepgram.com/examples/avatars/angus.jpg",
"sample": "https://static.deepgram.com/examples/voices/angus.wav",
"tags": [
"masculine"
]
}
},
... additional TTS Models.
]
}GET /models/
Section titled “GET /models/”Returns the metadata for a specific model. If the model is not found a 404 error is returned. This endpoint works for public models only.
Request
Section titled “Request”curl --location 'https://api.deepgram.com/v1/models/MODEL_UUID' \Results
Section titled “Results”{
"name": "angus",
"canonical_name": "aura-angus-en",
"architecture": "aura",
"language": ["en"],
"version": "2024-03-28.0",
"uuid": "af6e9977-99f6-4d8f-b6f5-dfdf6fb6e291",
"metadata": {
"accent": "Irish",
"color": "#BA80F5",
"tags": ["masculine"],
"image": "https://static.deepgram.com/examples/avatars/angus.jpg",
"sample": "https://static.deepgram.com/examples/voices/angus.wav"
}
}GET /projects//models/
Section titled “GET /projects//models/”Returns the metadata for a specific model that a particular project has access to. If the model is not found a 404 error is returned. This endpoint works for both public models and models accessible by the specified project.
Request
Section titled “Request”curl --location 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/models/MODEL_UUID' \
--header 'Authorization: Token YOUR_DEEPGRAM_API_KEY'Results
Section titled “Results”{
"name": "angus",
"canonical_name": "aura-angus-en",
"architecture": "aura",
"language": ["en"],
"version": "2024-03-28.0",
"uuid": "af6e9977-99f6-4d8f-b6f5-dfdf6fb6e291",
"metadata": {
"accent": "Irish",
"color": "#BA80F5",
"tags": ["masculine"],
"image": "https://static.deepgram.com/examples/avatars/angus.jpg",
"sample": "https://static.deepgram.com/examples/voices/angus.wav"
}
}