AI Text Sentiment Analysis API

Hosted on ApyHub

What it does

Text Sentiment Analyzer lets you send a text string and get sentiment analysis back from one of three providers: ApyHub, Azure, or Google. Use it when you need to classify customer feedback, scan reviews, or triage support messages by tone.

The request body requires body.text. You can also include body.encoding, body.language, and body.requested_service to choose the provider and describe the text. If you want to run it against your own cloud account, the schema also supports provider-specific credentials under body.azure or body.google.

The response returns a data object with a provider-specific result under azure, apyhub, or google, depending on which service you requested. The schema does not expose a fixed sentiment label or score here, so plan to handle the provider response structure directly.

Use Text Sentiment Analyzer for moderation workflows, survey analysis, or any pipeline where you need a machine-readable pass on opinionated text without building your own NLP layer.

Provider (requested_service)	Atoms
Azure	500
Google	500
ApyHub	2000

POST

Analyze text sentiment

https://api.eu.apyhub.com/apyhub/analyze-text-sentiment

QUICKSTART

GUIDE

Quickstart

Send the text you want analyzed in a JSON request body.

curl -X POST "https://api.eu.apyhub.com/apyhub/analyze-text-sentiment" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"text":"I absolutely love this new feature!", "language":"en", "requested_service":"apyhub"}'

What you'll get back

Returns a JSON object with a data object field. The data object may include azure, apyhub, and google response objects, depending on the service used.

{
  "data": {
    "azure": {},
    "apyhub": {},
    "google": {}
  }
}

TRY ITLIVE · 500 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Analyzes the sentiment of the submitted text. The request body must include text, and you can optionally provide provider-specific credentials or choose which service to use via requested_service; the response returns a JSON object with a data object containing provider-specific result objects.

Request Body

Parameter	Type	Mandatory	Description
text	String	Yes	Text to analyze.
azure	Object	No	Custom credentials for Azure services. See nested fields below.
azure.key	String	No	Azure subscription key.
azure.region	String	No	Azure service region.
azure.endpoint	String	No	Azure endpoint URL.
azure.account_id	String	No	Azure account ID.
azure.access_token	String	No	OAuth access token for Azure service.
google	Object	No	Custom credentials for Google services. See nested fields below.
google.google_language	String	No	Target language locale.
google.google_credential_json	Object	No	Google credential JSON object. See nested fields below.
google.google_credential_json.type	String	No	Service account type.
google.google_credential_json.auth_uri	String	No	Authorization URI.
google.google_credential_json.client_id	String	No	Client ID.
google.google_credential_json.token_uri	String	No	Token URI.
google.google_credential_json.project_id	String	No	Project ID.
google.google_credential_json.private_key	String	No	Private key.
google.google_credential_json.client_email	String	No	Service account email.
google.google_credential_json.private_key_id	String	No	Private key ID.
google.google_credential_json.universe_domain	String	No	Universe domain.
google.google_credential_json.client_x509_cert_url	String	No	Client X.509 certificate URL.
google.google_credential_json.auth_provider_x509_cert_url	String	No	Auth provider X.509 certificate URL.
encoding	String	No	Text encoding.
language	String	No	Language of the input text.
requested_service	ENUM	No	Which provider to use. Allowed values: `azure`, `google`, `apyhub`. Default: `apyhub`.

Response

Returns a JSON object with a data object field. The data object may contain provider-specific result objects for azure, apyhub, and/or google, depending on the requested service and runtime behavior.

Parameter	Type	Mandatory	Description
data	Object	No	Container for provider-specific response objects.
data.azure	Object	No	Response object from Microsoft Azure Cognitive Services.
data.apyhub	Object	No	Response object from ApyHub language tools.
data.google	Object	No	Response object from Google Cloud NLP API.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.