{
"error": false,
"sentiment": {
"kind": "negative",
"confidence": 1
},
"tone": {
"kind": "professional",
"confidence": 0.33
},
"insult": 0.02,
"violence": 0.01,
"sexuality": 0.06,
"substance_abuse": 0.1,
"hate_speech": 0.03,
"profanity": 0.05,
"political_content": 0.04,
"medical_content": 0.04,
"advertisement": 0.08,
"educational_content": 0.05,
"entertainment": 0.19,
"humor": 0.04,
"sarcasm_and_irony": 0.05,
"clickbait": 0.04,
"spoilers": 0.13,
"misinformation": 0.1,
"copyright_infringement": 0.09,
"urgency_and_scams": 0.15,
"toxicity": 0.09,
"userLabels": {
"isTechSupportRequest": 0.09,
"isBillingSupportRequest": 0.94,
"isRefundRequest": 0.99,
"mentionsCompetitor": 0.01
}
}
curl --location --request POST 'https://zylalabs.com/api/13862/textinsights+-+custom+text+classification+api/31878/analyze' --header 'Authorization: Bearer YOUR_API_KEY'
--data-raw '{
"text": "Hello, i would like to request a refund",
"includeDefaultPreset": true,
"userLabels": {
"isTechSupportRequest": "Is this a technical support request?",
"isBillingSupportRequest": "Is this a billing support request?",
"isRefundRequest": "Is the user requesting a refund?",
"mentionsCompetitor": "Does the text mention a competing company?"
}
}'
After signing up, every developer is assigned a personal API access key, a unique combination of letters and digits provided to access to our API endpoint. To authenticate with the TextInsights - Custom text classification API simply include your bearer token in the Authorization header.
| Header | Description |
|---|---|
Authorization
|
Required
Should be Bearer access_key. See "Your API Access Key" above when you are subscribed.
|
No long-term commitment. Upgrade, downgrade, or cancel anytime. Free Trial includes up to 50 requests.
(Save 2 months with annual billing 🎉)
Classification with custom labels to identify categories like isTechSupportRequest, isAdvertisement, isCatMentioned, or isHateSpeech, and anything you want
The analyze endpoint returns a JSON object containing insights about the input text. This includes default insights like sentiment, tone, and various content signals, as well as user-defined labels that indicate specific categories relevant to your application.
Key fields in the response include "error" (indicating success or failure), "sentiment" (with kind and confidence), "tone" (with kind and confidence), and "userLabels" (showing the confidence scores for custom labels defined by the user).
The response data is structured as a JSON object. It includes a top-level "error" field, followed by nested objects for "sentiment" and "tone," and a "userLabels" object that lists custom labels with their corresponding confidence scores.
The analyze endpoint accepts a text parameter containing the text to be analyzed. Additionally, users can define custom labels by specifying the label names and descriptions in their request to tailor the analysis to their needs.
The analyze endpoint provides insights into sentiment, tone, and various content signals such as hate speech, profanity, and user-defined categories. This allows for a comprehensive understanding of the text's context and implications.
Users can leverage the returned data to identify trends, monitor content for compliance, or enhance user experience by categorizing text based on custom labels. For example, businesses can filter support requests or detect harmful content using the insights provided.
Typical use cases include customer support automation, content moderation, sentiment analysis for marketing, and categorizing user-generated content. Businesses can tailor the API to meet specific needs, such as identifying refund requests or detecting advertisements.
Data accuracy is maintained through continuous updates and improvements to the underlying algorithms. The API leverages machine learning techniques to ensure that the insights provided are relevant and reliable, adapting to new language patterns and trends.
To obtain your API key, first sign in to your account and navigate to the API you want to use. From the API's Pricing section, choose a plan and complete the subscription process. Once subscribed, return to the API page and you will see your API Access Key displayed at the top of the documentation page. You can use this key to authenticate your requests.
You can’t switch APIs during the free trial. If you subscribe to a different API, your trial will end and the new subscription will start as a paid plan.
The free trial lasts for 7 days and allows you to make up to 50 API requests.
No, the free trial is available only once, so we recommend using it on the API that interests you the most. Most of our APIs offer a free trial, but some may not include this option.
Yes. If the API offers a free trial, you will see a "Free 7-Day Trial" option in its Pricing section. The trial lasts for 7 days and allows up to 50 API requests, enabling you to evaluate the API before subscribing to a paid plan.
Zyla API Hub is like a big store for APIs, where you can find thousands of them all in one place. We also offer dedicated support and real-time monitoring of all APIs. Once you sign up, you can pick and choose which APIs you want to use. Just remember, each API needs its own subscription. But if you subscribe to multiple ones, you'll use the same key for all of them, making things easier for you.
You can monitor your API usage through the response headers included with every request:
x-zyla-api-calls-monthly-used: Shows the total number of API requests you have used during the current billing period.
x-zyla-api-calls-monthly-remaining: Shows the number of API requests you have remaining for the current billing period.
Yes, you can cancel your subscription at any time. Simply go to the Pricing section of the API you're subscribed to and click the "Unsubscribe" button.
Please note that upgrades, downgrades, and cancellations take effect immediately. Once your subscription is canceled, access to the service will end immediately, regardless of any remaining API calls in your quota.
Please have a look at our Refund Policy: https://zylalabs.com/terms#refund