CRcreatify
transcription

POST /api/transcription/

Changed on

Transcribe speech in an audio or video file with word-level timestamps.

Async only — POST returns immediately with a job id; poll the detail route or supply webhook_url. Billed by the length of media transcribed.

Request

  • The document declares no server URL.
  • Auth
    API key in header X-API-ID and API key in header X-API-KEY

Request body

audio_urlstring uri required

Publicly accessible URL of the audio or video file to transcribe.

languagestring

ISO-639-1 language code of the speech (e.g. 'en'). Omit to auto-detect.

diarizeboolean

Label each word with the speaker who said it.

keytermsstring[]

Words or phrases likely to appear in the audio (product names, jargon) to improve their recognition. Max 100.

webhook_urlstring uri

Webhook URL called once the transcription finishes or fails.

Response

idstring uuid required
status'pending' | 'running' | 'failed' | 'done' required
  • pending - Pending
  • running - Running
  • failed - Failed
  • done - Done
audio_urlstring uri required

URL of the audio or video file to transcribe.

languagestring required

Requested ISO-639-1 language code. Empty means auto-detect.

diarizeboolean required
textstring required

Full transcript. Empty until the job is done.

language_detectedstring nullable required

Language code of the transcribed speech.

durationnumber double nullable required

Seconds of media transcribed.

credits_usednumber required

Credits charged, based on the length of media transcribed. 0 when the transcription fails.

failed_reasonstring required

Reason for failure if status is failed.

created_atstring date-time required
updated_atstring date-time required

Changes