HAhappyscribe
Exports

Retrieve an export

Retrieves an export. When its state is ready, download the file from download_link.

get/exports/{id}

Request

  • Base URL
    https://www.happyscribe.com/api/v1
  • Auth
    API key in header Authorization

Path parameters

idstring required

ID of the export.

Response

The export.

idstring
state'pending' | 'processing' | 'ready' | 'expired' | 'failed'
  • pending — waiting to be processed
  • processing — the export is being generated
  • ready — ready to download
  • expired — no longer available
  • failed — a problem occurred
format'txt' | 'docx' | 'pdf' | 'srt' | 'vtt' | 'stl' | 'avid' | 'avid_script' | 'avid_ds_subtitles' | 'avid_edl' | 'facebook_srt' | 'html' | 'premiere' | 'maxqda' | 'json' | 'fcp' | 'edl' | 'csv' | 'xlsx' | 'mp3' | 'mp4'

Export format:

  • txt — Text Document
  • docx — Word Document
  • pdf — PDF Document
  • srt — Subtitles (SubRip)
  • vtt — Subtitles (WebVTT)
  • stl — Subtitles (EBU-STL)
  • avid — Avid Markers
  • avid_script — Avid ScriptSync (Beta)
  • avid_ds_subtitles — Avid DS Subtitles
  • avid_edl — Avid Edit Decision List
  • facebook_srt — Facebook Subtitles
  • html — Interactive Transcript
  • premiere — Premiere Pro (Beta)
  • maxqda — Maxqda
  • json — JSON
  • fcp — Final Cut Pro
  • edl — DaVinci Resolve Markers
  • csv / xlsx — Excel
  • mp3 — Source audio
  • mp4 — Source video (video conversations only)
show_timestampsboolean
show_speakersboolean
show_commentsboolean
show_highlightsboolean
conversation_idsstring[]
download_linkstring

Present when state is ready. For mp3/mp4 it is a short-lived signed URL.

Example response

{
  "id": "export_id",
  "state": "ready",
  "format": "txt",
  "show_timestamps": false,
  "show_speakers": false,
  "show_comments": false,
  "show_highlights": false,
  "conversation_ids": [
    "e458099e7f8da14f9625854ba7b6a026917ad306"
  ],
  "download_link": "https://example.com/download"
}

Changes

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