Get the transcript
format=json returns text, segments and word timings. txt, srt and vtt return plain text; docx returns a Word document. Subtitle files (srt, vtt) come as subtitle cues by default: at most two lines of about 42 characters, on screen for one to seven seconds, split at sentence and clause boundaries, never inside a word. Pass cues=phrase for one cue per transcript segment. A locked job returns a preview for json and 402 for other formats.
Request
- Base URL: https://whipscribe.com/api
- URL: https://whipscribe.com/api/v1/jobs/{job_id}/result
- Auth: API key in header X-API-Key
Path parameters
The job id returned on submit.
Query parameters
How srt and vtt are cut. short: subtitle cues, at most two lines of about 42 characters (18 full-width characters for Chinese, Japanese and Korean), one to seven seconds each. phrase: one cue per transcript segment, whatever its length. Ignored for other formats.
Headers
Proves ownership of a job submitted without a user identity. The submit response returns it as claim_token.
Response
The transcript.
Example response
{
"text": "Welcome back to the show.",
"language": "en",
"segments": [
{
"start": 0,
"end": 2.1,
"speaker": "SPEAKER_00",
"text": "Welcome back to the show.",
"words": [
{
"start": 0,
"end": 0.4,
"text": "Welcome"
}
]
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.