Start processing

Initiates the transcription process for a job. Processing steps are determined by the job's profile and may include:

  • ASR (Automatic Speech Recognition)
  • Professional human editing
  • Speaker name assignment
  • Closed caption formatting

Prerequisites

  • At least one media file must be uploaded (POST /job/add_media)
  • Job must be in "Pending" status
  • Required metadata must be set

Monitoring Progress

Two options for tracking job status:

  1. Polling:

    • Periodically call GET /job/info
    • Check job_status field
    • Download results when status is "Completed"
  2. Webhook:

    • Configure webhook URL in profile or per-job
    • Receive automatic notification on completion
    • See Webhook section for setup details

Sandbox Testing

In sandbox mode:

  • No real processing occurs
  • Job stays "In Progress" by default
  • Use finish_in parameter to simulate completion
  • Use finish_with_error to simulate failures
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer
required

API version. Current version is 4. Older versions are supported but deprecated.

integer
required

Job ID (as received after calling POST /job/new)

Body Params
string

Callback URL (see "Webhook" section at the beginning of the doc).

options
object

Additional options for the transcription job

integer

Sandbox mode only. Pass this parameter for the job to automatically change state after
the specified number of seconds. State would be changed either to "Complete", or, if
finish_with_error=true passed, to "Error".

If this parameter is not passed, sandbox job will stay in "In Progress" state forever.

Value should be between 0 and 900 seconds (0-15 min).

boolean

Sandbox mode only. Can be passed with finish_in to imitate job finishing with an error.
If this parameter and finish_in is passed, the job will automatically change state
to "Error". If only finish_in but not finish_with_error is passed, the job will automatically
change state to "Complete". Otherwise, sandbox job will stay in "In Progress" state forever.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json