Jobs

Submit Forced Alignment Job

Starts an asynchronous job to obtain precise word timings for an audio file and text transcript. Audio can be specified by including a public url to the media via the source_config. A transcript can be specified by including a public url to the text file via the source_transcript_config or by submitting the text directly in the transcript_text field. Transcripts should contain only the words of a transcript (punctuation is omitted) separated by spaces.

SecurityAccessToken
Request
Request Body schema: application/json

Forced Alignment Job Options

metadata
string or null <= 512 characters

Optional metadata that was provided during job submission.

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.

object

URL to a media resource, and optional authorization headers if they are needed to access the resource at the URL. Headers could be a single Authorization header of the form <scheme> <token>, and one of the AWS signature v4 headers. This option will not be visible in the submission response.

object or null

URL to a text transcript resource, and optional authorization headers if they are needed to access the resource at the URL. Transcript should be a text file containing only the words of the transcript (no punctuation). Headers could be a single Authorization header of the form <scheme> <token>, and one of the AWS signature v4 headers. Only one of source_transcript_config and transcript_text may be set. This option will not be visible in the submission response.

transcript_text
string or null

The text of the transcript to be aligned. Should contain only words, no punctuation. One of either source_transcript_config or transcript_text is required

language
string or null
Default: "en"

The language of the submitted audio and transcript

Enum: "en" "es" "fr"
Responses
200

Alignment Job Details

400

Bad Request

401

Request Unauthorized

413

Payload Too Large

post/alignment/v1/jobs
Request samples
application/json
{}
Response samples
application/json
{
  • "id": "Umx5c6F7pH7r",
  • "status": "in_progress",
  • "created_on": "2018-05-05T23:23:22.29Z",
  • "type": "alignment"
}

Get List of Forced Alignment Jobs

Gets a list of alignment 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 Forced Alignment Jobs

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Job Not Found

get/alignment/v1/jobs
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Get Forced Alignment Job By Id
Returns information about a forced alignment job.


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


 
Responses 
200
Forced Alignment Job Details


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Job Not Found


get/alignment/v1/jobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "Umx5c6F7pH7r",
  • "status": "in_progress",
  • "created_on": "2018-05-05T23:23:22.29Z",
  • "type": "alignment"
}
Delete Forced Alignment Job by Id
Deletes a forced alignment 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
Job Not Found


409
Conflict


delete/alignment/v1/jobs/{id}
Request samples 
Response samples 
application/problem+json
{
  • "title": "Authorization has been denied for this request",
  • "status": 401
}
Get Forced Alignment Transcript By Id
Returns the results for a completed forced alignment job.


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


 
header Parameters
Accept
string
MIME type specifying the transcription output format


 Value: "application/vnd.rev.transcript.v1.0+json"  
Responses 
200
Rev AI API Forced Alignment Transcript


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Job Not Found


409
Conflict


get/alignment/v1/jobs/{id}/transcript
Request samples 
Response samples 
application/vnd.rev.transcript.v1.0+json
{
  • "monologues": [
    ]
}