# Analyze text content

**POST** `/v1/read`

Analyze text content using Deepgrams text analysis API

Base URL: `https://agent.deepgram.com`

Tags: `text`

## Authorization

| Option | Scheme | Type | Sent as | Scopes |
| --- | --- | --- | --- | --- |
| Option 1 | `ApiKeyAuth` | `apiKey` | header `Authorization` | — |

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `callback` | `string` | No | URL to which we'll make the callback request |
| `callback_method` | `string` | No | HTTP method by which the callback request will be made Allowed values: `POST`, `PUT`. |
| `sentiment` | `boolean` | No | Recognizes the sentiment throughout a transcript or text |
| `summarize` | — | No | Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only. |
| `tag` | — | No | Label your requests for the purpose of identification during usage reporting |
| `topics` | `boolean` | No | Detect topics throughout a transcript or text |
| `custom_topic` | — | No | Custom topics you want the model to detect within your input audio or text if present Submit up to `100`. |
| `custom_topic_mode` | `string` | No | Sets how the model will interpret strings submitted to the `custom_topic` param. When `strict`, the model will only return topics submitted using the `custom_topic` param. When `extended`, the model will return its own detected topics in addition to those submitted using the `custom_topic` param Allowed values: `extended`, `strict`. |
| `intents` | `boolean` | No | Recognizes speaker intent throughout a transcript or text |
| `custom_intent` | — | No | Custom intents you want the model to detect within your input audio if present |
| `custom_intent_mode` | `string` | No | Sets how the model will interpret intents submitted to the `custom_intent` param. When `strict`, the model will only return intents submitted using the `custom_intent` param. When `extended`, the model will return its own detected intents in the `custom_intent` param. Allowed values: `extended`, `strict`. |
| `language` | `string` | No | The [BCP-47 language tag](https://tools.ietf.org/html/bcp47) that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available |

## Request body

Optional. Media type: `application/json`

Analyze a text file

### Example request body

```json
{
  "url": "https://example.com"
}
```

## Responses

| Status | Description | Media type |
| --- | --- | --- |
| `200` | Successful text analysis | `application/json` |
| `400` | Invalid Request | `application/json` |

### Example response: 200 — Successful text analysis

```json
{
  "metadata": {
    "metadata": {
      "created": "2026-06-09T00:00:00Z",
      "intents_info": {
        "input_tokens": 0,
        "model_uuid": "00000000-0000-0000-0000-000000000000",
        "output_tokens": 0
      },
      "language": "string",
      "request_id": "00000000-0000-0000-0000-000000000000",
      "sentiment_info": {
        "input_tokens": 0,
        "model_uuid": "00000000-0000-0000-0000-000000000000",
        "output_tokens": 0
      },
      "summary_info": {
        "input_tokens": 0,
        "model_uuid": "00000000-0000-0000-0000-000000000000",
        "output_tokens": 0
      },
      "topics_info": {
        "input_tokens": 0,
        "model_uuid": "00000000-0000-0000-0000-000000000000",
        "output_tokens": 0
      }
    }
  },
  "results": {
    "intents": {
      "segments": [
        {
          "end_word": 0,
          "intents": [
            {
              "confidence_score": "string",
              "intent": "string"
            }
          ],
          "start_word": 0,
          "text": "string"
        }
      ]
    },
    "sentiments": {
      "average": {
        "sentiment": "string",
        "sentiment_score": 0
      },
      "segments": [
        {
          "end_word": 0,
          "sentiment": "string",
          "sentiment_score": 0,
          "start_word": 0,
          "text": "string"
        }
      ]
    },
    "summary": {
      "results": {
        "summary": {
          "text": "string"
        }
      }
    },
    "topics": {
      "segments": [
        {
          "end_word": 0,
          "start_word": 0,
          "text": "string",
          "topics": [
            {
              "confidence_score": "string",
              "topic": "string"
            }
          ]
        }
      ]
    }
  }
}
```

### Example response: 400 — Invalid Request

```json
{
  "err_code": "string",
  "err_msg": "string",
  "request_id": "string"
}
```

## Related pages

- [audio](./tags/audio.md)
- [balances](./tags/balances.md)
- [breakdown](./tags/breakdown.md)
- [configurations](./tags/configurations.md)
- [Create a Project Invite](./invites_create.md)
- [Create a Project Key](./keys_create.md)
- [Create a Project Self-Hosted Distribution Credential](./distributioncredentials_create.md)
- [Create an Agent Configuration](./configurations_create.md)
- [Create an Agent Variable](./variables_create.md)
- [Delete a Project](./projects_delete.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.