apyhub-logo
2000 atoms
AI tier

About

This Utility API uses AI to identify prevailing emotional opinions, classifying them as positive, negative, or neutral within any textual content.
This API aids in understanding public sentiment towards any brand or topic. By mining text for clues about sentiment and associating them with specific aspects of the content, the Sentiment Analysis API offers valuable insights into how people perceive and react to information.
Note: In order to test the API on API Playground, just click on "Show optional inputs" and enter the Authentication token for the provider before clicking on Send request. The output response structure and the result of the AI utility APIs depend on the service provider and it may vary depending on which service provider is selected.

API Playground

This API endpoint does not have a playground yet. Please check back later.

Documentation

input json: output json
POST
https://api.apyhub.com/ai/text/sentiment/analysis

Request example

1
curl --location --request POST 'https://api.apyhub.com/ai/text/sentiment/analysis' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
"text": "Great atmosphere. Close to plenty of restaurants, hotels, and transit! Staff are friendly and helpful.",
6
"language":"en",
7
"requested_service": "azure",
8
"azure": {
9
"key": "your-azure-key",
10
"endpoint": "your-azure-endpoint"
11
}
12
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
textStringYesthe textual content for which you want to perform sentiment analysis
languageStringyes (if azure is selected in requested_service)the language supported by azure chceck list of supported language link - https://learn.microsoft.com/en-gb/azure/ai-services/language-service/sentiment-opinion-mining/language-support
encodingStringNo (use if google is selected in requested_service)the textual content encoding format it can be UTF8,UTF16,UTF32 default to UTF8'
requested_serviceStringyesthe name of service provider for example azure,google
azure.keyStringyes (if azure is selected in requested_service)service key provided by azure
azure.endpointStringyes (if azure is selected in requested_service)the endpoint provided by azure
google.keyStringyes (if google is selected in requested_service)service key provided by google
Sample Response
A successful request returns the sentiment analysis response in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input - the file is corrupt or the supported inputs are not provided.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request.

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.