Analyze Text | Deepgram's Docs

import requests
url = "https://api.deepgram.com/v1/read"
payload = { "url": "https://example.com/audio/interview-episode1.mp3" }
headers = {
    "Authorization": "Token <apiKey>",
    "Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.json())

{
  "metadata": {
    "metadata": {
      "request_id": "d04af392-db11-4c1d-83e1-20e34f0b8999",
      "created": "2024-11-18T23:47:44.674Z",
      "language": "en",
      "summary_info": {
        "model_uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "input_tokens": 350,
        "output_tokens": 75
      },
      "sentiment_info": {
        "model_uuid": "f1e2d3c4-b5a6-7890-cdef-1234567890ab",
        "input_tokens": 350,
        "output_tokens": 10
      },
      "topics_info": {
        "model_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "input_tokens": 350,
        "output_tokens": 20
      },
      "intents_info": {
        "model_uuid": "0a1b2c3d-4e5f-6789-abcd-ef0123456789",
        "input_tokens": 350,
        "output_tokens": 15
      }
    }
  },
  "results": {
    "summary": {
      "results": {
        "summary": {
          "text": "This transcript highlights the significance of the first all-female spacewalk and honors the women pioneers who paved the way."
        }
      }
    },
    "topics": {
      "results": {
        "topics": {
          "segments": [
            {
              "text": "And, um, I think if it signifies anything, it is, uh, to honor the the women who came before us who, um, were skilled and qualified, um, and didn't get the the same opportunities that we have today.",
              "start_word": 32,
              "end_word": 69,
              "topics": [
                {
                  "topic": "Spacewalk",
                  "confidence_score": 0.91581345
                }
              ]
            }
          ]
        }
      }
    },
    "intents": {
      "results": {
        "intents": {
          "segments": [
            {
              "text": "If you found this valuable, you can subscribe to the show on spotify or your favorite podcast app.",
              "start_word": 354,
              "end_word": 414,
              "intents": [
                {
                  "intent": "Encourage podcasting",
                  "confidence_score": 0.0038975573
                }
              ]
            }
          ]
        }
      }
    },
    "sentiments": {
      "segments": [
        {
          "text": "Yeah. As as much as, um, it's worth celebrating, uh, the first, uh, spacewalk, um, with an all-female team, I think many of us are looking forward to it just being normal. And, um, I think if it_signf",
          "start_word": 0,
          "end_word": 69,
          "sentiment": "positive",
          "sentiment_score": 0.5810546875
        }
      ],
      "average": {
        "sentiment": "positive",
        "sentiment_score": 0.5810185185185185
      }
    }
  }
}

Analyze text content using Deepgrams text analysis API

Authentication

AuthorizationToken

Use Authorization: Token <API_KEY> Example: Authorization: Token 12345abcdef

AuthorizationBearer

Use Authorization: Bearer <JWT> Example: Authorization: Bearer eyJhbGciOiJ...

Query parameters

callbackstringOptional

URL to which we'll make the callback request

callback_methodenumOptionalDefaults to POST

HTTP method by which the callback request will be made

Allowed values:

sentimentbooleanOptionalDefaults to false

Recognizes the sentiment throughout a transcript or text

summarizeenum or booleanOptional

Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.

tagstring or list of stringsOptional

Label your requests for the purpose of identification during usage reporting

topicsbooleanOptionalDefaults to false

Detect topics throughout a transcript or text

custom_topicstring or list of stringsOptional

Custom topics you want the model to detect within your input audio or text if present Submit up to 100.

custom_topic_modeenumOptionalDefaults to extended

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

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:

intentsbooleanOptionalDefaults to false

Recognizes speaker intent throughout a transcript or text

custom_intentstring or list of stringsOptional

Custom intents you want the model to detect within your input audio if present

custom_intent_modeenumOptionalDefaults to extended

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:

languagestringOptionalDefaults to en

The BCP-47 language tag that hints at the primary spoken language. Depending on the Model and API endpoint you choose only certain languages are available

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

Analyze a text file

ReadV1RequestUrlobjectRequired

ReadV1RequestTextobjectRequired

Response

Successful text analysis

metadataobject

resultsobject

Errors

400

Bad Request Error