Transcription

Transcribe a file

Upload an audio or video file as multipart/form-data. The job is queued; poll GET /v1/jobs/{job_id} until it is done.

post/v1/transcribe

Request

  • Base URL: https://whipscribe.com/api
  • URL: https://whipscribe.com/api/v1/transcribe
  • Auth: API key in header X-API-Key

Headers

Idempotency-Keystring

Optional. Retries that carry the same key (per API key) return the original job (HTTP 200, X-Idempotent-Replay: true) instead of creating a duplicate. Up to 255 characters from [A-Za-z0-9_.:/-].

Response

Idempotent replay of an earlier submit with the same Idempotency-Key.

job_idstring uuid required
status'queued' | 'processing' | 'done' | 'failed' required
claim_tokenstring

Returned only when no user identity was supplied. Send it as X-Claim-Token on later reads of this job.

Example response

{
  "job_id": "35f4be54-aa3e-4adc-85b7-b44f284d1fc3",
  "status": "queued"
}

Changes

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