Skip to content
APIs/
/
/
Get Sentiment Analysis Jo...

Rev AI Sentiment Analysis API (v1)

Rev AI Sentiment Analysis API

Download OpenAPI description
reference.json
reference.yaml
Overview
URL
https://www.rev.ai/
Rev
support@rev.com
License
Rev AI Terms of Service
Languages
Servers
Rev AI API
https://api.rev.ai
Mock server
https://docs.rev.ai/_mock/api/sentiment-analysis/reference

Jobs

Operations

Submit Sentiment Analysis Job

Request

Starts an asynchronous job to analyze sentiments in a transcript. The transcript can be supplied through text as plain text or json as a rev.com transcript format

Security
AccessToken
Bodyapplication/jsonrequired

Sentiment Analysis Job Options

metadatastring or null<= 512 characters

Optional metadata that was provided during job submission.

notification_configobject or null

Optional configuration for a callback url to invoke when processing is complete, in addition to auth headers if they are needed to invoke the callback url. Cannot be set if callback_url is set. This option will not be visible in the submission response.

delete_after_secondsinteger or null[ 0 .. 2592000 ]

Amount of time after job completion when job is auto-deleted. Present only when preference set in job request.

languagestring or null

The user input language of the transcript.

Default "en"
Value"en"
Example: "en"
textstring or null

Plain text to be analyzed in this job submission. No timestamps will be included in the response if input is provided this way.

Example: "Plain text I would like processed."
jsonobject or null

Rev AI transcript to be analyzed in this job submission. With this input timestamps will be in result.

callback_urlstring or null<= 1024 charactersDeprecated

Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the notification_config parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.

Example: "https://www.example.com/callback"
curl -i -X POST \
  https://api.rev.ai/sentiment_analysis/v1/jobs \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "language": "en",
    "metadata": "sample user provided metadata",
    "notification_config": {
      "url": "https://www.example.com/callback",
      "auth_headers": {
        "Authorization": "Bearer <notification-url-token>"
      }
    },
    "delete_after_seconds": 1000000,
    "json": {
      "monologues": [
        {
          "speaker": 1,
          "elements": [
            {
              "type": "text",
              "value": "hello",
              "ts": 0.75,
              "end_ts": 1.25,
              "confidence": 0.85
            }
          ]
        }
      ]
    }
  }'

Responses

Sentiment Analysis Job Details

Bodyapplication/json
idstring

Id of the job.

Example: "Umx5c6F7pH7r"
created_onstring(date-time)

The date and time the job was created in ISO-8601 UTC form.

Example: "2018-05-05T23:23:22.29Z"
completed_onstring or null(date-time)

The date and time the job was completed, whether successfully or failing, in ISO-8601 UTC form.

Example: "2018-05-05T23:28:22.29Z"
metadatastring or null<= 512 characters

Optional metadata that was provided during job submission.

failure_detailstring or null

Human-readable reason why the job failed.

Example: "Internal server error."
delete_after_secondsinteger or null[ 0 .. 2592000 ]

Amount of time after job completion when job is auto-deleted. Present only when preference set in job request.

statusstring

Current status of the job.

Enum"in_progress""completed""failed"
Example: "completed"
failurestring

Simple reason of why the job failed. Check failure_detail for specific details and solutions.

Enum"internal_processing""insufficient_balance""invoicing_limit_exceeded""input_too_small""input_too_large"
languagestring or null

The user input language of the transcript.

Default "en"
Value"en"
Example: "en"
word_countinteger or null

The amount of words processed.

Example: 4231
typestring

The type of action performed, in this case sentiment_analysis

Value"sentiment_analysis"
Example: "sentiment_analysis"
callback_urlstring or null<= 1024 charactersDeprecated

Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the notification_config parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.

Example: "https://www.example.com/callback"
Response
application/json
{
  "id": "Umx5c6F7pH7r",
  "status": "in_progress",
  "language": "en",
  "created_on": "2018-05-05T23:23:22.29Z",
  "callback_url": "https://www.example.com/callback",
  "type": "sentiment_analysis"
}

Get List of Sentiment Analysis Jobs

Request

Gets a list of sentiment analysis jobs submitted within the last 30 days in reverse chronological order up to the provided limit number of jobs per call. Note: Jobs older than 30 days will not be listed. Pagination is supported via passing the last job id from a previous call into starting_after.

Security
AccessToken
Query
limitinteger or null[ 0 .. 1000 ]

Limits the number of jobs returned, default is 100, max is 1000

Default 100
starting_afterstring or null

If specified, returns jobs submitted before the job with this id, exclusive (job with this id is not included)

curl -i -X GET \
  'https://api.rev.ai/sentiment_analysis/v1/jobs?limit=100&starting_after=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of Rev AI Sentiment Analysis Jobs

Bodyapplication/jsonArray [
idstring

Id of the job.

Example: "Umx5c6F7pH7r"
created_onstring(date-time)

The date and time the job was created in ISO-8601 UTC form.

Example: "2018-05-05T23:23:22.29Z"
completed_onstring or null(date-time)

The date and time the job was completed, whether successfully or failing, in ISO-8601 UTC form.

Example: "2018-05-05T23:28:22.29Z"
metadatastring or null<= 512 characters

Optional metadata that was provided during job submission.

failure_detailstring or null

Human-readable reason why the job failed.

Example: "Internal server error."
delete_after_secondsinteger or null[ 0 .. 2592000 ]

Amount of time after job completion when job is auto-deleted. Present only when preference set in job request.

statusstring

Current status of the job.

Enum"in_progress""completed""failed"
Example: "completed"
failurestring

Simple reason of why the job failed. Check failure_detail for specific details and solutions.

Enum"internal_processing""insufficient_balance""invoicing_limit_exceeded""input_too_small""input_too_large"
languagestring or null

The user input language of the transcript.

Default "en"
Value"en"
Example: "en"
word_countinteger or null

The amount of words processed.

Example: 4231
typestring

The type of action performed, in this case sentiment_analysis

Value"sentiment_analysis"
Example: "sentiment_analysis"
callback_urlstring or null<= 1024 charactersDeprecated

Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the notification_config parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.

Example: "https://www.example.com/callback"
]
Response
application/json
[
  {
    "id": "Umx5c6F7pH7r",
    "status": "in_progress",
    "language": "en",
    "created_on": "2018-05-05T23:23:22.29Z",
    "type": "sentiment_analysis"
  },
  {
    "id": "6BxQYGa638Yt",
    "status": "completed",
    "language": "en",
    "created_on": "2018-05-05T23:23:22.29Z",
    "completed_on": "2018-05-05T23:45:13.41Z",
    "callback_url": "https://www.example.com/callback",
    "word_count": 4231,
    "type": "sentiment_analysis"
  }
]

Get Sentiment Analysis Job By Id

Request

Returns information about a sentiment analysis job

Security
AccessToken
Path
idstringrequired

Rev AI API Job Id

curl -i -X GET \
  'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Sentiment Analysis Job Details

Bodyapplication/json
idstring

Id of the job.

Example: "Umx5c6F7pH7r"
created_onstring(date-time)

The date and time the job was created in ISO-8601 UTC form.

Example: "2018-05-05T23:23:22.29Z"
completed_onstring or null(date-time)

The date and time the job was completed, whether successfully or failing, in ISO-8601 UTC form.

Example: "2018-05-05T23:28:22.29Z"
metadatastring or null<= 512 characters

Optional metadata that was provided during job submission.

failure_detailstring or null

Human-readable reason why the job failed.

Example: "Internal server error."
delete_after_secondsinteger or null[ 0 .. 2592000 ]

Amount of time after job completion when job is auto-deleted. Present only when preference set in job request.

statusstring

Current status of the job.

Enum"in_progress""completed""failed"
Example: "completed"
failurestring

Simple reason of why the job failed. Check failure_detail for specific details and solutions.

Enum"internal_processing""insufficient_balance""invoicing_limit_exceeded""input_too_small""input_too_large"
languagestring or null

The user input language of the transcript.

Default "en"
Value"en"
Example: "en"
word_countinteger or null

The amount of words processed.

Example: 4231
typestring

The type of action performed, in this case sentiment_analysis

Value"sentiment_analysis"
Example: "sentiment_analysis"
callback_urlstring or null<= 1024 charactersDeprecated

Deprecated. Use notification_config instead. Optional callback url to invoke when processing is complete. If this parameter is used to pass in the callback url, the callback url will be visible in the response. It is recommended to provide webhooks with the notification_config parameter as authorization headers can be included and both the callback url and auth headers will be encrypted when stored.

Example: "https://www.example.com/callback"
Response
application/json
{
  "id": "Umx5c6F7pH7r",
  "status": "in_progress",
  "language": "en",
  "created_on": "2018-05-05T23:23:22.29Z",
  "callback_url": "https://www.example.com/callback",
  "type": "sentiment_analysis"
}

Delete Sentiment Analysis Job by Id

Request

Deletes a sentiment analysis job. All data related to the job will be permanently deleted. A job can only be deleted once it's completed (either with success or failure).

Security
AccessToken
Path
idstringrequired

Rev AI API Job Id

curl -i -X DELETE \
  'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Job was successfully deleted

Body
Response
No content

Get Sentiment Analysis Result By Id

Request

Returns the results for a completed sentiment analysis job.

Security
AccessToken
Path
idstringrequired

Rev AI API Job Id

Query
filter_forstring or null

Filter for sentiments. If specified only messages with the specified sentiment will be returned

Enum"positive""negative""neutral"
curl -i -X GET \
  'https://api.rev.ai/sentiment_analysis/v1/jobs/{id}/result?filter_for=positive' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Rev AI API Sentiment Analysis Result

Bodyapplication/vnd.rev.sentiment.v1.0+json
messagesArray of objects

List of messages containing phrases from the input with their detected sentiment. Positional properties will be different depending on the type of submission.

One of:

List of messages containing phrases from the input with their detected sentiment. Positional properties will be different depending on the type of submission.

Response
application/vnd.rev.sentiment.v1.0+json
{
  "messages": [
    { … },
    { … },
    { … }
  ]
}