Analyze Text

Analyze text content using Deepgram's text analysis API

Headers

AuthorizationstringRequired

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

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:
languageenumOptionalDefaults to en
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
OR
ReadV1RequestTextobjectRequired

Response

Successful text analysis
metadataobject
resultsobject

Errors