Skip to main content
POST
text.analyze

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
text
string

Text to analyze, up to 10000 characters.

Required string length: 1 - 10000
url
string

Public URL of a UTF-8 text document, up to 10000 characters.

fileId
string

Id of an uploaded file holding UTF-8 text to analyze, up to 10000 characters, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
language
string
default:en

Language of the text. Default en.

Pattern: ^[a-z]{2}$
summary
boolean
default:false

Summarize the submitted content.

topics
boolean
default:false

Identify topics in the content.

sentiment
boolean
default:false

Describe sentiment of text spans, without scoring a person.

intents
boolean
default:false

Identify expressed intentions in text spans.

customTopics
string[]

Up to 100 custom topic labels.

Maximum array length: 100

A topic to detect.

Required string length: 1 - 200
topicMode
enum<string>
default:extended

Strict returns only custom topics; extended also detects others.

Available options:
strict,
extended
customIntents
string[]

Up to 100 custom intent labels.

Maximum array length: 100

An intent to detect.

Required string length: 1 - 200
intentMode
enum<string>
default:extended

Strict returns only custom intents; extended also detects others.

Available options:
strict,
extended

Response

The result

summary
string

Summary of the submitted content.

topics
object[]

Topic spans.

intents
object[]

Intent spans.

sentiments
object[]

Sentiment spans.

averageSentiment
object

Average sentiment of the content.