Text Intelligence API

API ID 13314

CPU-based NLP aggregate — sentiment, toxicity, language detection, NER, semantic similarity, and spellcheck.

360 ms avg response

API Documentation

Endpoints

Request
Classify text as positive or negative with a confidence score
Endpoint ID: 27577
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27577/classify+text+as+positive+or+negative+with+a+confidence+score
INPUT PARAMETERS

Classify text as positive or negative with a confidence score — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "text": "This product is absolutely amazing! Best purchase I've made all year.",
    "label": "positive",
    "score": 0.9999
}
Classify text as positive or negative with a confidence score — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27577/classify+text+as+positive+or+negative+with+a+confidence+score' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "text": "This product is absolutely amazing! Best purchase I've made all year."
    }'

    
Request
Classify multiple texts in a single request Use this endpoint to process your data.
Endpoint ID: 27578
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27578/classify+multiple+texts+in+a+single+request
INPUT PARAMETERS

Classify multiple texts in a single request — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "results": [
        {
            "label": "positive",
            "score": 0.9999
        },
        {
            "label": "negative",
            "score": 0.9903
        },
        {
            "label": "negative",
            "score": 0.9821
        }
    ]
}
Classify multiple texts in a single request — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27578/classify+multiple+texts+in+a+single+request' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "texts": [
        "Great product, love it!",
        "Terrible experience, never again.",
        "It was okay, nothing special."
      ]
    }'

    
Request
Detect whether text is toxic or harmful Use this endpoint to process your data.
Endpoint ID: 27579
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27579/detect+whether+text+is+toxic+or+harmful
INPUT PARAMETERS

Detect whether text is toxic or harmful — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "text": "I love spending time with my family and friends.",
    "toxic": true,
    "label": "toxic",
    "score": 0.0009
}
Detect whether text is toxic or harmful — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27579/detect+whether+text+is+toxic+or+harmful' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "text": "I love spending time with my family and friends."
    }'

    
Request
Detect the language of a text with per-language probability breakdown
Endpoint ID: 27580
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27580/detect+the+language+of+a+text+with+per-language+probability+breakdown
INPUT PARAMETERS

Detect the language of a text with per-language probability breakdown — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "detected": "fr",
    "probabilities": [
        {
            "lang": "fr",
            "prob": 1
        }
    ]
}
Detect the language of a text with per-language probability breakdown — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27580/detect+the+language+of+a+text+with+per-language+probability+breakdown' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "text": "Bonjour, comment allez-vous aujourd'hui?"
    }'

    
Request
Compute cosine similarity score between two texts using sentence embeddings
Endpoint ID: 27582
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27582/compute+cosine+similarity+score+between+two+texts+using+sentence+embeddings
INPUT PARAMETERS

Compute cosine similarity score between two texts using sentence embeddings — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "text1": "The cat sat on the mat.",
    "text2": "A feline rested on a rug.",
    "similarity": 0.553
}
Compute cosine similarity score between two texts using sentence embeddings — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27582/compute+cosine+similarity+score+between+two+texts+using+sentence+embeddings' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "text1": "The cat sat on the mat.",
      "text2": "A feline rested on a rug."
    }'

    
Request
Detect misspelled words and return a corrected version of the text
Endpoint ID: 27584
POST https://docs.zylalabs.com/api/13314/text+intelligence+api/27584/detect+misspelled+words+and+return+a+corrected+version+of+the+text
INPUT PARAMETERS

Detect misspelled words and return a corrected version of the text — Endpoint Features

Object Description
Request Body Required Json

Free test requests remaining: 3 of 3.


INPUT PARAMETERS

API EXAMPLE RESPONSE
JSON
{
    "original": "Ths sentance has som speling mistaeks.",
    "corrected": "Ths sentence has som spelling mistakes",
    "misspelled": {
        "speling": "spelling",
        "mistaeks.": "mistakes",
        "ths": "the",
        "sentance": "sentence"
    }
}
Detect misspelled words and return a corrected version of the text — CODE SNIPPETS

curl --location --request POST 'https://zylalabs.com/api/13314/text+intelligence+api/27584/detect+misspelled+words+and+return+a+corrected+version+of+the+text' --header 'Authorization: Bearer YOUR_API_KEY' 

--data-raw '{
      "text": "Ths sentance has som speling mistaeks."
    }'

    

API Access Key & Authentication

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 Text Intelligence API simply include your bearer token in the Authorization header.

Headers
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 🎉)

🚀 Enterprise Plan

Starts at
$ 10,000/Year


  • Custom Volume
  • Custom Rate Limit
  • Specialized Customer Support
  • Real-Time API Monitoring
zeiss-logo amazon-logo zoom-logo decathlon-logo

Trusted by leading companies

Overview

CPU-based NLP aggregate — sentiment, toxicity, language detection, NER, semantic similarity, and spellcheck.

Text Intelligence API FAQs

Each endpoint returns structured JSON data. For example, the sentiment endpoint returns a label (positive/negative) and a confidence score, while the toxicity endpoint indicates whether the text is toxic and provides a score.

Key fields include "label" and "score" for sentiment, "toxic" and "label" for toxicity, "detected" and "probabilities" for language detection, and "similarity" for similarity scores. Each endpoint has specific fields relevant to its function.

Parameters vary by endpoint. For instance, the sentiment endpoint accepts a single text input, while the batch sentiment endpoint accepts an array of texts. The similarity endpoints require two texts or a list of candidates and a query.

Response data is organized in a JSON format with clear key-value pairs. For example, the spellcheck endpoint returns the original text, corrected text, and a dictionary of misspelled words with their corrections.

The API utilizes open-source models trained on various datasets. For example, the toxicity model is trained on Jigsaw data, ensuring a diverse and comprehensive understanding of language nuances.

Typical use cases include sentiment analysis for customer feedback, toxicity detection in user-generated content, language detection for multilingual applications, and spellchecking in text processing tools.

Users can customize requests by selecting specific endpoints and providing relevant text inputs. For batch processing, users can send multiple texts in a single request to optimize performance.

If an endpoint returns partial or empty results, users should check the input data for errors or ensure that the text is not too short. Implementing error handling in the application can help manage such scenarios effectively.

General FAQs

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.

Prices are listed in USD (United States Dollar), EUR (Euro), CAD (Canadian Dollar), AUD (Australian Dollar), and GBP (British Pound). We accept all major debit and credit cards. Our payment system uses the latest security technology and is powered by Stripe, one of the world's most reliable payment companies. If you have any trouble paying by card, just contact us at [email protected]

Additionally, if you already have an active subscription in any of these currencies (USD, EUR, CAD, AUD, GBP), that currency will remain for subsequent subscriptions. You can change the currency at any time as long as you don't have any active subscriptions.
The local currency shown on the pricing page is based on the country of your IP address and is provided for reference only. The actual prices are in USD (United States Dollar). When you make a payment, the charge will appear on your card statement in USD, even if you see the equivalent amount in your local currency on our website. This means you cannot pay directly with your local currency.
Occasionally, a bank may decline the charge due to its fraud protection settings. We suggest reaching out to your bank initially to check if they are blocking our charges. Also, you can access the Billing Portal and change the card associated to make the payment. If these does not work and you need further assistance, please contact our team at [email protected]
Prices are determined by a recurring monthly or yearly subscription, depending on the chosen plan.
API calls are deducted from your plan based on successful requests. Each plan comes with a specific number of calls that you can make per month. Only successful calls, indicated by a Status 200 response, will be counted against your total. This ensures that failed or incomplete requests do not impact your monthly quota.
Zyla API Hub works on a recurring monthly subscription system. Your billing cycle will start the day you purchase one of the paid plans, and it will renew the same day of the next month. So be aware to cancel your subscription beforehand if you want to avoid future charges.
To upgrade your current subscription plan, simply go to the pricing page of the API and select the plan you want to upgrade to. The upgrade will be instant, allowing you to immediately enjoy the features of the new plan. Please note that any remaining calls from your previous plan will not be carried over to the new plan, so be aware of this when upgrading. You will be charged the full amount of the new plan.
To check how many API calls you have left for the current month, refer to the 'X-Zyla-API-Calls-Monthly-Remaining' field in the response header. For example, if your plan allows 1,000 requests per month and you've used 100, this field in the response header will indicate 900 remaining calls.

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.

The 'X-Zyla-RateLimit-Reset' header shows the number of seconds until your rate limit resets. This tells you when your request count will start fresh. For example, if it displays 3,600, it means 3,600 seconds are left until the limit resets.

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.

After 7 days, you will be charged the full amount for the plan you were subscribed to during the trial. Therefore, it's important to cancel before the trial period ends. Refund requests for forgetting to cancel on time are not accepted.
When you subscribe to an API free trial, you can make up to 50 API calls. If you wish to make additional API calls beyond this limit, the API will prompt you to perform an "Start Your Paid Plan." You can find the "Start Your Paid Plan" button in your profile under Subscription -> Choose the API you are subscribed to -> Pricing tab.
You can contact us through our chat channel to receive immediate assistance. We are always online from 8 am to 5 pm (EST). If you reach us after that time, we will get back to you as soon as possible. Additionally, you can contact us via email at [email protected]

Please have a look at our Refund Policy: https://zylalabs.com/terms#refund


Related APIs


You might also like