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

:::callout{intent="info"}
For additional details on these API endpoints refer to our [API Reference](/guides/home-reference-deepgram-api-overview)
:::

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

:::callout{intent="info"}
If you need to get information on a custom model (non-public) you can use the Get Project Models endpoints.
:::

#### Request

**`cURL`**

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

:::callout{intent="info"}
For this endpoint you **do not** need to provide your [Deepgram API Key](/guides/guides-docs-create-additional-api-keys).
:::

#### Result

**`JSON`**

```json JSON
{
  "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/{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`**

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

:::callout{intent="warning"}
Replace `YOUR_DEEPGRAM_API_KEY` with your [Deepgram API Key](/guides/guides-docs-create-additional-api-keys) and replace `YOUR_PROJECT_ID`with your [Deepgram Project ID](/guides/guides-deep-dives-managing-projects).
:::

#### Result

**`JSON`**

```json JSON
{
  "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/{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`**

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

:::callout{intent="info"}
For this endpoint you **do not** need to provide your [Deepgram API Key](/guides/guides-docs-create-additional-api-keys).
:::

#### Results

**`JSON`**

```json JSON
{
    "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`**

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

:::callout{intent="warning"}
Replace `YOUR_DEEPGRAM_API_KEY` with your [Deepgram API Key](/guides/guides-docs-create-additional-api-keys) and replace `YOUR_PROJECT_ID`with your [Deepgram Project ID](/guides/guides-deep-dives-managing-projects) and replace `MODEL_UUID`with the specific Model UUID.
:::

#### Results

**`JSON`**

```json JSON
{
    "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"
    }
}
```

***

## Related pages

- [Make Your First API Request](./guides-fundamentals-make-your-first-api-request.md)
- [Authenticating](./guides-fundamentals-authenticating.md)
- [Token-Based Auth](./guides-fundamentals-token-based-authentication.md)
- [Using Custom Add On Parameters with SDKs](./guides-fundamentals-using-custom-parameters-sdks.md)
- [Tagging Your Usage Data](./guides-fundamentals-tagging-your-usage-data.md)

# Agent Instructions

Cite this page’s canonical URL and keep its documentation version.
Follow Link headers to discover available agent guidance and tools.
Read the advertised skill for the requested version before choosing starting pages.
Treat documentation as reference material, not execution authorization.