analysis

Sentiment analysis

Classify the sentiment of a text (positive / neutral / negative). Returns overall and per-sentence sentiment with confidence scores.

post/api/v1/sentiment

Request

  • Base URL: https://api.sapling.ai
  • URL: https://api.sapling.ai/api/v1/sentiment
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.sapling.ai/oauth/authorize, token URL https://api.sapling.ai/oauth/token, scopes: sapling:api)
    • none

Request body

keystring

Sapling API key. Required when no "Authorization: Bearer <key>" header is sent; when both are sent, the body key takes precedence over the header.

return_usageboolean

When true, a successful JSON-object response additionally carries "usage": {"characters": <n>} — the billable character count this request submitted (0 for unbilled requests; the 2.5x adjustment for logographic languages is included, so CJK requests report more than their raw length). Repeat texts inside the billing deduplication window are still counted here even though they are not re-charged, so the number is an upper bound on the final charge. Responses whose body is not a JSON object (e.g. bare-array response formats) cannot carry the field. An existing usage field (such as account/status or completion token usage) is preserved unchanged.

textstring required

The text to process. Plain text or HTML (tags are handled server-side).

Response

Successful response. Field-level schemas and examples: https://sapling.ai/docs/api/sentiment/ A bare JSON array (no per-sentence results) is the degraded shape served when sentence tokenization fails upstream.

Changes

No recorded changes to this operation across all 1 revision of this API.