Jobs

Submit Sentiment Analysis Job

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

SecurityAccessToken
Request
Request Body schema: application/json

Sentiment Analysis Job Options

metadata
string or null <= 512 characters

Optional metadata that was provided during job submission.

callback_url
string or null <= 1024 characters
Deprecated

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.

object 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_seconds
integer or null [ 0 .. 2592000 ]

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

language
string or null
Default: "en"

The user input language of the transcript.

Value: "en"
text
string 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.

object or null

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

Responses
200

Sentiment Analysis Job Details

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Deployment does not support this API

413

Payload Too Large

post/sentiment_analysis/v1/jobs
Request samples
application/json
{
  • "language": "en",
  • "metadata": "sample user provided metadata",
  • "notification_config": {},
  • "delete_after_seconds": 1000000,
  • "json": {
    }
}
Response samples
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

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.

SecurityAccessToken
Request
query Parameters
limit
integer or null [ 0 .. 1000 ]
Default: 100

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

starting_after
string or null

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

Responses
200

List of Rev AI Sentiment Analysis Jobs

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Unable to find resource or deployment does not support this API

get/sentiment_analysis/v1/jobs
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Get Sentiment Analysis Job By Id
Returns information about a sentiment analysis job


SecurityAccessToken 
Request 
path Parameters
id
required
string
Rev AI API Job Id


 
Responses 
200
Sentiment Analysis Job Details


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Unable to find resource or deployment does not support this API


get/sentiment_analysis/v1/jobs/{id}
Request samples 
Response samples 
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
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).


SecurityAccessToken 
Request 
path Parameters
id
required
string
Rev AI API Job Id


 
Responses 
204
Job was successfully deleted


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Unable to find resource or deployment does not support this API


409
Conflict


delete/sentiment_analysis/v1/jobs/{id}
Request samples 
Response samples 
application/problem+json
{
  • "title": "Authorization has been denied for this request",
  • "status": 401
}
Get Sentiment Analysis Result By Id
Returns the results for a completed sentiment analysis job.


SecurityAccessToken 
Request 
path Parameters
id
required
string
Rev AI API Job Id


 
query Parameters
filter_for
string or null
Filter for sentiments. If specified only messages with the specified sentiment will be returned


 Enum: "positive" "negative" "neutral"  
Responses 
200
Rev AI API Sentiment Analysis Result


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Unable to find resource or deployment does not support this API


409
Conflict


get/sentiment_analysis/v1/jobs/{id}/result
Request samples 
Response samples 
application/vnd.rev.sentiment.v1.0+json
{
  • "messages": [
    ]
}