Errors
Top Level Errors
When accessing the Receptiviti API, any errors that are generated during usage are returned with an error code and description. Errors that occur at the top level are typically due to problems with authentication or malformed request bodies. The following section will discuss all the top level errors in detail.
Overview
These errors occur before any text is scored and will typically be related to authentication, your plan, or the format of your request body. Each corresponds to an HTTP response code.
| Error Type | Error Code | HTTP Status Code | Message |
|---|---|---|---|
| Authentication | |||
| 1410 | 401 | Missing Authorization header. | |
| 1411 | 401 | Unrecognized API Key pair. This call will not count towards your plan. | |
| 1412 | 401 | Your plan does not include access to this endpoint. This call will not count towards your plan. | |
| Plan And Usage | |||
| 1420 | 429 | Rate limit exceeded. Retry in X seconds. This call will not count towards your plan. | |
| Request Size | |||
| 1430 | 413 | The request body exceeded the limit of 10 MB/5 MB (bulk call/single call). This call will not count towards your plan. | |
| 1431 | 413 | The bulk request exceeded the limit of 1000 elements. | |
| Request Body | |||
| 1440 | 400 | The request body could not be read. | |
| 1441 | 400 | The request body was not valid JSON. This call will not count towards your plan. | |
| 1442 | 400 | The 'content' field must be a string. | |
| 1443 | 400 | The 'request_id' field must be a string. | |
| 1444 | 400 | The bulk request was empty. | |
| System Errors | |||
| 1500 | 500 | An internal server error has occurred. |
Nested Errors
Some errors are returned at the nested level within the response. These errors occur due to the contents of the payload and are nested within the response body. These are typically caused by missing fields in your request body. They do not have an HTTP response code associated with them because errors occur at the level of individual pieces of text and not the overall request, so the status code of the overall response will be 200.
| Error Type | Error Code | Message |
|---|---|---|
| Plan And Usage | ||
| 1421 | Plan word limit reached. | |
| Request Body | ||
| 1450 | Missing the content field. | |
| 1451 | request_id cannot be longer than 64 characters. | |
| System Errors | ||
| 1500 | An internal server error has occurred. |