---
title: "Get the transcript"
method: GET
path: "/v1/jobs/{job_id}/result"
tags: ["Jobs"]
---

# Get the transcript

`GET /v1/jobs/{job_id}/result`

## 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`

`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.

## Path parameters

- `job_id` string, uuid, required

## Query parameters

- `format` 'json' | 'txt' | 'srt' | 'vtt' | 'docx'
- `cues` 'short' | 'phrase'

## Headers

- `X-Claim-Token` string

## Response `200`

The transcript.

- Transcript
  - `text` string
  - `language` string, nullable
  - `segments` Segment[]
    - `start` number
    - `end` number
    - `speaker` string, nullable
    - `text` string
    - `words` Word[]
      - `start` number
      - `end` number
      - `text` string
  - `speech_detected` boolean

## Other responses

- `400`: Malformed request (e.g. `BAD_ID`, `BAD_URL`, `BAD_IDEMPOTENCY_KEY`).
- `401`: Missing or invalid API key, or the job needs an ownership proof (`X-Claim-Token`).
- `402`: Not enough credit (`NO_CREDITS`, `INSUFFICIENT_CREDITS_FOR_DURATION`), or the finished transcript is locked (`transcript_locked`). With your own API key the body also carries `checkout_url`: a card checkout link for your account that a person can open and pay; then repeat the request.
- `404`: Unknown job id, or a job that is not yours.
- `409`: The job has not finished yet (`NOT_READY`).
- `429`: Too many requests; retry with backoff (`RATE_LIMITED`, `QUOTA_EXCEEDED`).

---

[API](https://skmtc.dev/whipscribe/apis/whipscribe-api.md) · [All operations](https://skmtc.dev/whipscribe/apis/whipscribe-api/llms.txt) · [OpenAPI document](https://skmtc.dev/whipscribe/apis/whipscribe-api/revisions/cac5ec5d99d5?raw)
