Modify Job¶

Modify parameters of an already existing job. The job must be in Authorization state.

HTTP Method

POST /api/job/modify¶

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`
job_id	Description	The ID of the job which is being modified
	Allowed Values	Hex String
	Example	`job_id=64bea283eff6475ea6596027a6ba0929`

Query String Parameters — Optional

Name	Details
transcription_fidelity	Description	The desired fidelity of the transcription
	Allowed Values	Fidelity Enumeration
	Example	`transcription_fidelity=PREMIUM`
turnaround_hours	Description	The number of hours after which the job is returned
	Allowed Values	Integer
	Example	`turnaround_hours=36`
priority	Description	The desired priority of the transcription
	Allowed Values	Priority Enumeration
	Example	`priority=STANDARD`
account_id	Description	The username of the account to be assigned to the job
	Allowed Values	String
	Example	`account_id=john_doe`
requestor_id	Description	ID of user requesting the job (helpful for grouping)
	Allowed Values	String
	Example	requestor_id=sample_id
callback_url	Description	Desired callback URL (URL to POST results to
	Allowed Values	String
	Example	callback_url=https://sample.com/webhook
expected_speakers	Description	Amount of speakers that the video will have
	Allowed Values	Integer
	Example	`expected_speakers=40`
notes	Description	Terms, Names, etc. to aid in human transcription
	Allowed Values	String
	Example	`Interviewee is Dee`

Responses

HTTP Code	Details
204	Description	Success
204	Contents	none
400	Description	An error occurred
400	Contents	Error description (see Error Format for details)

Example Requests

POST /api/job/modify HTTP/1.1
Host: api.cielo24.com
Body: v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f
      &job_id=64bea283eff6475ea6596027a6ba0929
      &transcription_fidelity=PREMIUM&priority=STANDARD&account_id=john_doe

Example Response

HTTP/1.1 204 OK