SIsimplified
transcription

Media · Transcription · Start a video/audio transcription job (step 1 of 3)

Step 1 — submit a media URL for speech-to-text transcription.

The response is only {id}. It does not contain the transcript and it does not contain any status flag. The STT pipeline runs asynchronously and updates the row later via provider webhooks.

Next steps:

  • Step 2: poll getTranscription with the returned id until job_status="DONE" (or "FAILED").
  • Step 3: optionally call downloadTranscriptionFile to get VTT/SRT.
post/api/v1/transcription/transcribe

Request

  • Base URL
    https://api.simplified.com
  • Auth
    API key in header Authorization

Request body

video_urlstring uri required

URL of the source video or audio file.

language_codestring

BCP-47 language code of the source audio. Defaults to "en-US".

Response

Transcription completed (the apikit middleware blocks until terminal). Response is the full TranscriptionResponse when job_status="DONE", or an {error, id, status, message} envelope when the job fails or times out.

idstring

Transcription UUID. Use this with getTranscription and downloadTranscriptionFile.

titlestring
creatorinteger

Creator user ID.

video_urlstring

Source media URL submitted for transcription.

transcribed_video_urlstring nullable

URL of the captioned/burned-in video, if produced.

transcription_urlstring nullable

URL of the raw transcript artifact in storage.

payloadobject

Transcription payload. When job_status=COMPLETED, contains language_code and phrases (each with speaker, text, and words[{text, start, end, confidence}] in milliseconds).

contentobject

Source metadata (e.g. {source, source_id}).

job_status'CREATED' | 'PENDING' | 'PROCESSING' | 'DONE' | 'FAILED' | 'RENDERING' | 'UPDATED'

Lifecycle state of the transcription job. Terminal: DONE (success) and FAILED. All other values are non-terminal — keep polling.

statusstring

Project status (PUBLIC, PRIVATE, ARCHIVED).

project_typestring

Always "transcription" for this resource.

createdstring date-time
modifiedstring date-time
translation_languagestring nullable
provider'GGL' | 'AWS' | 'MS' | 'OAI' | 'AAI'

STT engine used for the job.

Changes

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