Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
93 lines (77 sloc) 6.49 KB

Modify Job

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

HTTP Method

.. http: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 :ref:`fidelity-label`
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 :ref:`priority-label`
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


HTTP Code Details
204 Description Success
Contents none
400 Description An error occurred
Contents Error description (see :ref:`error-format-label` for details)

Example Requests

POST /api/job/perform_transcription HTTP/1.1
Body: v=1&api_token=7ca5dc5c7cce449fb0fff719307e8f5f

Example Response

HTTP/1.1 204 OK