Transcription

Finish a direct upload and start transcription

Call after the file bytes have been uploaded to the ticket's upload_url. Echo back object_key and options from the ticket.

post/v1/uploads/{job_id}/commit

Request

  • Base URL: https://whipscribe.com/api
  • URL: https://whipscribe.com/api/v1/uploads/{job_id}/commit
  • Auth: API key in header X-API-Key

Path parameters

job_idstring uuid required
Example:35f4be54-aa3e-4adc-85b7-b44f284d1fc3

The job id returned on submit.

Request body

object_keystring required

object_key from the upload ticket.

optionsobject required

options from the upload ticket, unchanged.

original_filenamestring

Optional display name for the job.

Response

Already committed; returns the existing job.

job_idstring uuid required
status'queued' | 'processing' | 'done' | 'failed' required
claim_tokenstring

Returned only when no user identity was supplied. Send it as X-Claim-Token on later reads of this job.

Example response

{
  "job_id": "35f4be54-aa3e-4adc-85b7-b44f284d1fc3",
  "status": "queued"
}

Changes

No recorded changes to this operation across all 1 revision of this API.