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.
Ask AIPlaygroundLoginFree API Key
HomeAPI ReferenceVoice AgentSpeech-to-TextText-to-SpeechIntelligenceSelf-Hosted Deployments
HomeAPI ReferenceVoice AgentSpeech-to-TextText-to-SpeechIntelligenceSelf-Hosted Deployments
    • Home
    • Ask AI
    • Support
    • Changelog
  • Trust & Security
    • Security Policy
    • Data Privacy Compliance
    • Information Security & Privacy
  • SDKs
    • SDK Features
  • Guides
      • Make Your First API Request
      • Authenticating
      • Token-based Auth
      • Model Metadata
      • Using Custom Add On Parameters with SDKs
      • Tagging Your Usage Data
LogoLogo
Ask AIPlaygroundLoginFree API Key
On this page
  • Enable Feature
  • GET /models
  • Request
  • Result
  • GET /projects/{project}/models
  • Request
  • Result
  • GET /models/{modelId}
  • Request
  • Results
  • GET /projects/{project}/models/{modelId}
  • Request
  • Results
GuidesFundamentals

Model Metadata

Use the Models endpoint to determine which models you can access and returns metadata about those models.
Was this page helpful?
Previous

Using Custom Add On Parameters with SDKs

Learn how to use custom add on parameters to set arbitrary key/value pairs with the Deepgram SDKs.

Next
Built with

The Models endpoint allows users to efficiently query all available public models or private models and determine which models they have access to.

For additional details on these API endpoints refer to our API Reference

Enable Feature

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.`

If you need to get information on a custom model (non-public) you can use the Get Project Models endpoints.

Request

cURL
$curl --location 'https://api.deepgram.com/v1/models' \

For this endpoint you do not need to provide your Deepgram API Key.

Result

JSON
1{
2  "stt": [
3  	{
4      "name": "general",
5      "canonical_name": "nova-3-general",
6      "architecture": "nova3",
7      "languages": [
8        "en",
9        "en-US"
10      ],
11      "version": "2025-01-09.0",
12      "uuid": "bf05427e-a1f1-4ced-a976-38b2f3533d8d",
13      "batch": false,
14      "streaming": true,
15      "formatted_output": false
16    },
17    // ... other STT models
18  ],
19  "tts": [
20    {
21      "name": "angus",
22      "canonical_name": "aura-angus-en",
23      "architecture": "aura",
24      "languages": [
25        "en",
26        "en-IE"
27      ],
28      "version": "2024-11-19.0",
29      "uuid": "b50880e3-4e2e-4e53-ba27-ea0472bf2cf4",
30      "metadata": {
31        "accent": "Irish",
32        "color": "#BA80F5",
33        "image": "https://static.deepgram.com/examples/avatars/angus.jpg",
34        "sample": "https://static.deepgram.com/examples/voices/angus.wav",
35        "tags": [
36          "masculine"
37        ]
38      }
39    },
40    // ... other TTS models
41  ]
42}

GET /projects/{project}/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

cURL
$curl --location 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/models' \
>--header 'Authorization: Token YOUR_DEEPGRAM_API_KEY'

Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key and replace YOUR_PROJECT_IDwith your Deepgram Project ID.

Result

JSON
1{
2  "stt": [
3    {
4      "name": "general",
5      "canonical_name": "nova-3-general",
6      "architecture": "nova3",
7      "languages": [
8        "en",
9        "en-US"
10      ],
11      "version": "2025-01-09.0",
12      "uuid": "bf05427e-a1f1-4ced-a976-38b2f3533d8d",
13      "batch": false,
14      "streaming": true,
15      "formatted_output": false
16    },
17		... additional STT Models.
18  ],
19  "tts": [
20    {
21      "name": "angus",
22      "canonical_name": "aura-angus-en",
23      "architecture": "aura",
24      "languages": [
25        "en",
26        "en-IE"
27      ],
28      "version": "2024-11-19.0",
29      "uuid": "b50880e3-4e2e-4e53-ba27-ea0472bf2cf4",
30      "metadata": {
31        "accent": "Irish",
32        "color": "#BA80F5",
33        "image": "https://static.deepgram.com/examples/avatars/angus.jpg",
34        "sample": "https://static.deepgram.com/examples/voices/angus.wav",
35        "tags": [
36          "masculine"
37        ]
38      }
39    },
40		... additional TTS Models.
41  ]
42}

GET /models/{modelId}

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

cURL
$curl --location 'https://api.deepgram.com/v1/models/MODEL_UUID' \

For this endpoint you do not need to provide your Deepgram API Key.

Results

JSON
1{
2    "name": "angus",
3    "canonical_name": "aura-angus-en",
4    "architecture": "aura",
5    "language": ["en"],
6    "version": "2024-03-28.0",
7    "uuid": "af6e9977-99f6-4d8f-b6f5-dfdf6fb6e291",
8    "metadata": {
9        "accent": "Irish",
10        "color": "#BA80F5",
11        "tags": ["masculine"],
12        "image": "https://static.deepgram.com/examples/avatars/angus.jpg",
13        "sample": "https://static.deepgram.com/examples/voices/angus.wav"
14    }
15}

GET /projects/{project}/models/{modelId}

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

cURL
$curl --location 'https://api.deepgram.com/v1/projects/YOUR_PROJECT_ID/models/MODEL_UUID' \
>--header 'Authorization: Token YOUR_DEEPGRAM_API_KEY'

Replace YOUR_DEEPGRAM_API_KEY with your Deepgram API Key and replace YOUR_PROJECT_IDwith your Deepgram Project ID and replace MODEL_UUIDwith the specific Model UUID.

Results

JSON
1{
2    "name": "angus",
3    "canonical_name": "aura-angus-en",
4    "architecture": "aura",
5    "language": ["en"],
6    "version": "2024-03-28.0",
7    "uuid": "af6e9977-99f6-4d8f-b6f5-dfdf6fb6e291",
8    "metadata": {
9        "accent": "Irish",
10        "color": "#BA80F5",
11        "tags": ["masculine"],
12        "image": "https://static.deepgram.com/examples/avatars/angus.jpg",
13        "sample": "https://static.deepgram.com/examples/voices/angus.wav"
14    }
15}