v3

latestOpenAPI 3.1.02026-08-0150254154.0 KB
read > v1 > text

Analyze text content

Analyze text content using Deepgrams text analysis API

post/v1/read

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

Headers

Authorizationstring required

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

Request body

OR

Response

Successful text analysis