Score Single Call (Deprecated)

Note: The /score endpoint is deprecated and will be removed in version 2 of the Receptiviti API; release date expected late 2022.

Single Call to Score

POST /v1/score

Overview

The score endpoint incorporates the same measures and scores as framework, yet organizes the scores in a alternate arrangement, such that 0-1 scores go in dictionary_measures and 0-100 scores go into receptiviti_measures. Use this endpoint to obtain scores for a single sample of text. The payload consists of a single JSON object.

Limits

  • Total payload cannot exceed 5MB
  • Limited to 10 requests per second per user.

Request

A JSON object with the following fields:

FieldRequiredTypeDetails
contentYesStringThe text you want to score. This is the only required field and it does not have a default.
request_idStringThis field can be used if you want to associate an identifier with a piece of text. It will be returned with the response. It does not have a default.
curl --location --request \
POST 'https://api.receptiviti.com/v1/score' \
-u <YOUR_API_KEY>:<YOUR_API_SECRET> \
--header 'Content-Type: application/json' \
--data-raw '{
"request_id": "req-1",
"content": "Some thrilling content..."
}'

Response

Top-level fields:

FieldTypeDetails
plan_usageObjectDetails about how many words have been used and how much of your word limit remains for the current period.
resultsArray of objectsThere will be one object for each sample of text in the request. That means for for single-score calls, there will be exactly one object while for bulk-score requests, there will be as many result objects as there were requests.