API ReferenceText Intelligence API

Analyze Text

Analyze text content using Deepgram's text analysis API

Headers

AuthorizationstringRequired

Header authentication of the form Token <token>

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:
custom_topicstringOptional
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
languageenumOptionalDefaults 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

sentimentbooleanOptionalDefaults to false
Recognizes the sentiment throughout a transcript or text
summarizeenumOptional
Summarize content. For Listen API, supports string version option. For Read API, accepts boolean only.
Allowed values:
topicsbooleanOptionalDefaults to false
Detect topics throughout a transcript or text

Request

This endpoint expects an object.
objectRequired
OR
objectRequired

Response

Successful text analysis
metadataobject
resultsobject

Errors