Score Bulk Call (Deprecated)

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

Bulk Call to Score

POST /v1/score/bulk

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 multiple samples of text. The payload consists of an array or list of JSON object.

Limits

  • Total payload cannot exceed 10MB
  • Number of objects in the array cannot exceed 1,000
  • Limited to 10 requests per second per user

Request

An array of JSON objects 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/bulk' \
-u <YOUR_API_KEY>:<YOUR_API_SECRET> \
--header 'Content-Type: application/json' \
--data-raw '[
{
"request_id": "req-1",
"content": "Some thrilling content..."
},
{
"request_id": "req-2",
"content": "More thrilling content..."
},
{
"request_id": "req-3",
"content": "Even more 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.