Model Metadata

Pre-recorded Streaming Text to Speech

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.

Request

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

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

Result

{
    "stt": [
        {
            "name": "2-medical",
            "canonical_name": "nova-2-medical",
            "architecture": "nova-2",
            "languages": [
                "en",
                "en-au",
                "en-ca",
                "en-gb",
                "en-ie",
                "en-in",
                "en-my",
                "en-nz",
                "en-ph",
                "en-us",
                "en-za"
            ],
            "version": "2024-06-11.4692",
            "uuid": "46658e06-4884-4582-9bc2-e92ef7baa396",
            "batch": false,
            "streaming": true,
            "formatted_output": true

        },
        ... additional SST Models.
    ],
    "tts": [
        {
            "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"
            }
        },
        ... additional TTS Models.       
    ]
}

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

{
    "stt": [
        {
            "name": "2-medical",
            "canonical_name": "nova-2-medical",
            "architecture": "nova-2",
            "languages": [
                "en",
                "en-au",
                "en-ca",
                "en-gb",
                "en-ie",
                "en-in",
                "en-my",
                "en-nz",
                "en-ph",
                "en-us",
                "en-za"
            ],
            "version": "2024-06-11.4692",
            "uuid": "46658e06-4884-4582-9bc2-e92ef7baa396",
            "batch": false,
            "streaming": true,
            "formatted_output": true

        },
        ... additional SST Models.
    ],
    "tts": [
        {
            "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"
            }
        },
        ... additional TTS Models.       
    ]
}

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 --location 'https://api.deepgram.com/v1/models/MODEL_UUID' \

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

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/{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 --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

{
    "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"
    }
}