Jobs

Submit Language Identification Job

Starts an asynchronous job to identify the most probable language in the audio. Audio can be specified in two ways, either by including a public url to the media via the source_config option or by uploading a local file as part of a multipart/form request.

SecurityAccessToken
Request
Request Body schema:

Language Identification 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.

object or null

Optional authorization headers, if they are needed to access the resource at the URL. Headers must either be a single Authorization header of the form <scheme> <token> or (AWS signature v4 headers)[https://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-auth-using-authorization-header.html] Only one of source_config and media_url may be set. This option will not be visible in the submission response.

media_url
string <= 2048 characters
Deprecated

[HIPAA unsupported] Deprecated. Use source_config instead. Direct download media url. If this parameter is used to pass in the media url, the media url will be visible in the response. It is recommended to use the source_config parameter instead, as authorization headers can be included and both the source url and auth headers will be encrypted when stored.

Responses
200

Language Identification Job Details

400

Bad Request

401

Request Unauthorized

403

Request forbidden or user does not have permission to access this deployment

413

Payload Too Large

post/languageid/v1/jobs
Request samples
{
  • "metadata": "sample user provided metadata",
  • "notification_config": {},
  • "delete_after_seconds": 1000000,
  • "source_config": {}
}
Response samples
application/json
{
  • "id": "Umx5c6F7pH7r",
  • "status": "in_progress",
  • "created_on": "2018-05-05T23:23:22.29Z",
  • "type": "language_id"
}

Get List of Language Identification Jobs

Gets a list of language identification 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 Language Identification Jobs

400

Bad Request

401

Request Unauthorized

403

User does not have permission to access this deployment

404

Job Not Found

get/languageid/v1/jobs
Request samples 
Response samples 
application/json
[
  • {
    },
  • {
    }
]
Get Language Identification Job By Id
Returns information about a language identification job.


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


 
Responses 
200
Language Identification Job Details


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Job Not Found


get/languageid/v1/jobs/{id}
Request samples 
Response samples 
application/json
{
  • "id": "Umx5c6F7pH7r",
  • "status": "in_progress",
  • "created_on": "2018-05-05T23:23:22.29Z",
  • "type": "language_id"
}
Delete Language Identification Job by Id
Deletes a language identification 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/languageid/v1/jobs/{id}
Request samples 
Response samples 
application/problem+json
{
  • "title": "Authorization has been denied for this request",
  • "status": 401
}
Get Language Identification Result By Id
Returns the results for a completed language identification job.


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


 
Responses 
200
Rev AI API Language Identification Result


401
Request Unauthorized


403
User does not have permission to access this deployment


404
Job Not Found


409
Conflict


get/languageid/v1/jobs/{id}/result
Request samples 
Response samples 
application/json
{
  • "top_language": "en",
  • "language_confidences": [
    ]
}