text

Analyze text content

Changed on

Analyze text content using Deepgrams text analysis API

post/v1/read

Request

  • Base URL
    https://api.deepgram.com
  • Auth
    API key in header Authorization

Query parameters

callbackstring

URL to which we'll make the callback request

callback_method'POST' | 'PUT'

HTTP method by which the callback request will be made

sentimentboolean

Recognizes the sentiment throughout a transcript or text

'v2'
OR
boolean

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

string
OR
string[]

Label your requests for the purpose of identification during usage reporting

topicsboolean

Detect topics throughout a transcript or text

string
OR
string[]

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

custom_topic_mode'extended' | 'strict'

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

intentsboolean

Recognizes speaker intent throughout a transcript or text

string
OR
string[]

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

custom_intent_mode'extended' | 'strict'

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.

languagestring

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

Request body

OR

Response

Successful text analysis

Changes

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security ApiKeyAuth was added to the API