Overview
Sentiment Analysis works by analyzing the text and comparing it to a large database of sentiment analysis models. It uses advanced algorithms to analyze the sentiment of the text and returns the sentiment score and the sentiment label.
Endpoint
One host, one path per API. The block below shows this call in four languages; every one of them is the same HTTP request. Making requests covers the timeouts, retries and parameter rules that apply to all of them. The SDKs wrap the same call in a typed client.
curl -X POST https://api.apiverve.com/v1/sentimentanalysis \
-H "x-api-key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
}'const res = await fetch('https://api.apiverve.com/v1/sentimentanalysis', {
method: 'POST',
headers: {
'x-api-key': 'your_api_key_here',
'Content-Type': 'application/json',
},
body: JSON.stringify({
"text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
}),
});
if (!res.ok) throw new Error(`${res.status} ${await res.text()}`);
const { data } = await res.json();
console.log(data);import requests
res = requests.post(
"https://api.apiverve.com/v1/sentimentanalysis",
headers={"x-api-key": "your_api_key_here"},
json={
"text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
},
timeout=15,
)
res.raise_for_status()
print(res.json()["data"])package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
body := strings.NewReader(`{
"text": "I'm so excited that tomorrow is going to be sunny! Can't wait!"
}`)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/sentimentanalysis", body)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("x-api-key", "your_api_key_here")
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
out, _ := io.ReadAll(res.Body)
fmt.Println(string(out))
}Replace your_api_key_here with the key from your dashboard. When the inputs arrive as a list rather than one at a time, batch requests run up to 200 of them through this same API in a single call.
Authentication
Send your key in the x-api-key header. That is the only auth step — there is no token exchange and no per-endpoint scope to configure. Authentication covers creating, rotating and revoking keys.
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Parameters
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them.
| Parameter | Type | Description |
|---|---|---|
textRequired | string | The text to analyze the sentiment of |
Response
Every API returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape. Response format covers the envelope, the other output formats and how premium fields are withheld.
{
"status": "ok",
"error": null,
"data": {
"comparative": 0.25,
"sentimentText": "positive",
"sentiment": 3,
"isPositive": true,
"isNegative": false,
"normalizedScore": 0.3
}
}Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
comparative | number | 0.25 | |
sentimentText | string | "positive" | |
sentiment | number | 3 | |
isPositive | boolean | true | Whether the sentiment is positive |
isNegative | boolean | false | Whether the sentiment is negative |
normalizedScorePremium | number | 0.3 | Sentiment score normalized to -1 to 1 range |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change. Error handling covers the full status list and which of them are worth retrying.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted | A key restriction or IP allow-list; see key scoping. |
429 | Rate limited, or out of credits | Read error to tell them apart; see rate limits. |
Use cases
- Social Media Monitoring
- Use the Sentiment Analysis API to analyze text sentiment for social media monitoring. Use the data to track brand sentiment, monitor customer feedback, and identify trends
- Customer Feedback
- Analyze customer feedback by using the Sentiment Analysis API to evaluate text sentiment. Use the data to measure customer satisfaction, improve products, and enhance customer experience
- Market Research
- Conduct market research by using the Sentiment Analysis API to analyze text sentiment. Use the data to study consumer behavior, identify market trends, and make data-driven decisions
- Brand Reputation
- Monitor brand reputation by using the Sentiment Analysis API to analyze text sentiment. Use the data to assess brand sentiment, manage public relations, and respond to feedback
Other ways to use Sentiment Analysis
Set up Sentiment Analysis on APIVerve, or reach the same source a different way. Your APIVerve account and credits work on all of them — one key, one balance.
Related
More in AI/Computer Vision: