Create Job

Create a new job. A job is a container into which you can upload media and request that transcription be performed. Creating a job is prerequisite for virtually all other methods.

HTTP Method

GET /api/job/new

Query String Parameters — Required

Name	Details
v	Description	The version of the API to use
	Allowed Values	1
	Example	v=1
api_token	Description	The API token used for this session
	Allowed Values	Hex String
	Example	api_token=7ca5dc5c7cce449fb0fff719307e8f5f

Query String Parameters — Optional

Name	Details
job_name	Description	A human readable identifier for the job
	Allowed Values	String
	Example	job_name=example_name
language	Description	Native job language.
	Allowed Values	See Languages
	Default Value	en
	Example	language=en
external_id	Description	An identifier you want to associate with this job
	Allowed Values	String
	Default Value	None
	Example	external_id=12345
username	Description	Create the job in specified sub-account
	Allowed Values	String
	Example	username=my_sub_account
requestor	Description	An requestor you want to associate with this job
	Allowed Values	String
	Example	requestor=test_requestor
reference	Description	An reference you want to associate with this job
	Allowed Values	String
	Example	reference=test_reference
expected_speakers	Description	Amount of speakers that the video will have
	Allowed Values	Integer
	Example	expected_speakers=40
is_duplicate	Description	Allows creating multiple jobs with the same external_id
	Allowed Values	Boolean (not case-sensitive)
	Default Value	false
	Example	is_duplicate=true

Responses

HTTP Code	Details
200	Description	Success
	Contents	{ "JobId": "An ID which can be used to refer to this job", "TaskId": "An ID for tracking tasks within a job" }
400	Description	An error occurred
	Contents	Error description (see Error Format for details)

Example Requests

GET /api/job/new?v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
&job_name=example_name&language=en HTTP/1.1
Host: api.cielo24.com

Example Response

HTTP/1.1 200 OK
Content-Type: application/json

{
  "JobId" : "64bea283eff6475ea6596027a6ba0929",
  "TaskId" : "cc8095fbfecf4647b2e10b622d81c19b"
}