The Joyful Insights Forecasting (AI) API delivers emotional classification results, categorizing input data as either 'Happy' or 'Unhappy'. Utilizing advanced machine learning techniques, this API specializes in sentiment analysis to provide accurate predictions. For further details about the underlying model and its capabilities, please reach out to us.
{
"Value Prediction": "Happy"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10309/hapiness?X1=Required&X2=Required&X3=Required&X4=Required&X5=Required&X6=Required' --header 'Authorization: Bearer YOUR_API_KEY'
{
"X1": "the availability of information about the city services",
"X2": "the cost of housing",
"X3": "the overall quality of public schools",
"X4": "your trust in the local police",
"X5": "the maintenance of streets and sidewalks",
"X6": "the availability of social community events"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10310/listallvars' --header 'Authorization: Bearer YOUR_API_KEY'
{
"API Info:": "This API requests per values provide class result ('Happy' or 'Unhappy'). The AI algorithm consists of ML (Machine Learning) techniques for Classification task. Please contact us for more information about the model. We acknowledge the researchers involved in this study and thank them for providing the Dataset for Analysis. We here cite the dataset: 'Koczkodaj, W. (2017). Somerville Happiness Survey [Dataset]. UCI Machine Learning Repository. https://doi.org/10.24432/C5PW36.'"
}
curl --location --request GET 'https://zylalabs.com/api/6822/joyful+insights+forecasting+ai+api/10311/info' --header 'Authorization: Bearer YOUR_API_KEY'
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 Joyful Insights Forecasting AI 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 🎉)
Trusted by leading companies
This API request provides a class result ('Happy' or 'Unhappy') based on a requested mini-survey with answers ranging from 1 (Totally Disagree) to 5 (Totally Agree). The AI algorithm consists of ML (Machine Learning) techniques for the Classification task. For more information about the model, please contact us. We acknowledge the researchers involved in this study and thank them for providing the Dataset for Analysis. We here cite the dataset: 'Koczkodaj, W. (2017). Somerville Happiness Survey [Dataset]. UCI Machine Learning Repository.'
The "hapiness" endpoint returns a classification result indicating emotional state as either 'Happy' or 'Unhappy'. The "listallvars" endpoint provides a list of variables related to factors influencing happiness, while the "info" endpoint offers general information about the API and its underlying model.
The "hapiness" endpoint response includes "Value Prediction" indicating the emotional classification. The "listallvars" response contains variable names (e.g., "X1", "X2") and their descriptions, while the "info" endpoint provides a summary of the API's functionality and data sources.
Responses are structured in JSON format. For "hapiness", it returns a single key-value pair. The "listallvars" endpoint returns multiple key-value pairs for each variable, and the "info" endpoint provides a comprehensive overview in a single JSON object.
The "hapiness" endpoint provides emotional classifications, the "listallvars" endpoint details various factors affecting happiness, and the "info" endpoint gives insights into the API's functionality and data sources.
Currently, the API does not support customizable parameters for the "hapiness" or "listallvars" endpoints. Users can simply call these endpoints to receive the predefined data. Future enhancements may allow for more tailored requests.
The data utilized by the Joyful Insights Forecasting AI API is based on the Somerville Happiness Survey dataset, provided by Koczkodaj, W. (2017). This dataset is available in the UCI Machine Learning Repository, ensuring a reliable source for analysis.
Typical use cases include sentiment analysis for social research, understanding community well-being, and enhancing user experience in applications that require emotional insights. The data can help organizations gauge public sentiment on various issues.
Users can leverage the "hapiness" classification to assess emotional trends in their data, while the "listallvars" information can guide them in identifying key factors influencing happiness. This can inform decision-making in community planning or service improvements.
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