API Documentation

Getting Started

After you signup for an account and login, you will see your API key on your dashboard:

Screenshot of the API Key area on the Customer Dashboard

Opinions

Opinions are the customer text you have collected and would like scored by the Sentigrade Analyzer API.

Endpoint

POST /api/v1/opinions

Headers

Attributes

Content-Type required
application/json is the only option.

Authorization required
Permission to use the API.

Authorization.Token required
The API Key provided after sign up.

Authorization.email required
The email address for the Sentigrade.io account.

Headers

('Content-Type', 'application/json')
('Authorization', 'Token token="abcdefghij6b38befb38efb38961234567890",
email="chris@example.com"')

The Opinion Object

Attributes

request required
List of statements.

request.statement required
The provided text statement for grading.

POST /api/v1/opinions

{
  "request": [
    { "statement": "better than expected!!!" },
    { "statement": "ok" },
    { "statement": "sad :-(" }
  ]
}

Response

{ 
  "scored": [
    [
      "better than expected!!!",
      7.9
    ],
    [
      "ok",
      6.5
    ],
    [
      "sad :-(",
      1.6
    ]
  ],
  "errors": [
    [
      ""
    ]
  ],
  "processed": 3
}

Guidelines:

Requests must be made in application/json format
The request contains an array regardless the number of statements
Each statement you would like graded is declared with singular "statement"
Requests are limited to 100 statements

Any questions? Contact us and we will respond as quickly as possible.

Thanks for choosing Sentigrade!