Sentiment

curl -X POST "$DOATHING_API/v1/nlp/sentiment" \
  -H "x-api-key: $DOATHING_KEY" \
  -H "content-type: application/json" \
  -d '{"text": "The service was excellent, but the wait was not good."}'

Positive, negative or neutral, overall and sentence by sentence, with a score attached.

Score text sentiment with VADER, returning compound and per-sentence polarity.

Input

Send either a text string or a file object. A file is decoded as UTF-8 and must be one of text/plain, text/markdown, text/html, text/csv.

Response

The result carries your remaining balance alongside it, so you can track spend without a second call.

{
  "compound": 0.2263,
  "label": "positive",
  "positive": 0.24,
  "neutral": 0.646,
  "negative": 0.114,
  "sentence_count": 1,
  "request_id": "37f01edb-0163-42a1-ac51-0acaef979800",
  "credits_remaining": 96
}

Cost

3 credits per call, whether it is run from the site or from the API — the credential differs, the price does not. A new account starts with 20 credits.

A rejected request still costs a credit: the authorizer decrements before the tool validates. A call rejected for a missing or invalid key is free.