Docs
Back to site Get started

🚀 Quick Start Guide

This guide will help you get started with the Sentor ML API quickly and efficiently.

📋 Overview

Sentor ML provides powerful entity-based sentiment analysis through a simple REST API. You can analyze sentiment specifically related to entities mentioned in your text, extract insights, and gain valuable understanding from your data.

🔑 Getting Started

1. Get an API Key

For testing purposes, get a free API key by signing up to Sentor and we will provide you the key with free subscription plan.

For production use, we prefer upgrade to a paid plan to get a full API key.

2. Authentication

All requests to Sentor API require authentication using an API key. Include your API key in the request header:

x-api-key: YOUR_API_KEY

3. Make Your First API Call

Send a POST request to analyze entity-based sentiment:

English (Default):

curl -X 'POST' 
  'https://sentor.app/api/predicts' 
  -H 'accept: application/json' 
  -H 'x-api-key: YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
  "docs": [
    {
      "doc_id": "doc1",
      "doc": "Apple'''s new iPhone is amazing!",
      "entities": [
        "Apple",
        "iPhone"
      ]
    }
  ]
}'

Dutch:

curl -X 'POST' 
  'https://sentor.app/api/predicts?language=nl' 
  -H 'accept: application/json' 
  -H 'x-api-key: YOUR_API_KEY' 
  -H 'Content-Type: application/json' 
  -d '{
  "docs": [
    {
      "doc_id": "doc1",
      "doc": "Apple'''s nieuwe iPhone is geweldig!",
      "entities": [
        "Apple",
        "iPhone"
      ]
    }
  ]
}'

Response:

{
  "results": [
    {
      "doc_id": "doc1",
      "predicted_class": 2,
      "predicted_label": "positive",
      "probabilities": {
        "negative": 0.00010637386003509164,
        "neutral": 0.0002509312762413174,
        "positive": 0.9996427297592163
      },
      "details": [
        {
          "sentence_index": 0,
          "sentence_text": "Apple's new iPhone is amazing!",
          "predicted_class": 2,
          "predicted_label": "positive",
          "probabilities": {
            "negative": 0.00010637386003509164,
            "neutral": 0.0002509312762413174,
            "positive": 0.9996427297592163
          }
        }
      ]
    }
  ]
}

⚡ Rate Limits

For detailed rate limit information, see our Rate Limits Documentation.

🔄 Next Steps

📚 Additional Resources

🚀 Advanced Features

Ready for more? Sentor offers powerful tools for large-scale feedback analysis:

  • Document Clustering: Group thousands of documents into logical clusters automatically.
  • Topic Naming: Generate human-friendly names for your clusters using built-in LLMs.
  • AI Connectivity: Connect Sentor to ChatGPT, Claude, and other agents natively.

💬 Support