jobs

Job status, stage, error, result reference, billing

get/v1/jobs/{id}

Request

  • Base URL: https://api.transcriptdock.com
  • URL: https://api.transcriptdock.com/v1/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sb-access-token

Path parameters

idstring uuid required

Query parameters

waitinteger

Long poll. Hold the request up to this many seconds and return as soon as the job is succeeded, failed or cancelled. One rate-limited request replaces a client poll loop.

Response

Job record (terminal failures stay HTTP 200 with status failed)

idstring uuid required

Job id; use with GET /v1/jobs/{id}.

status'queued' | 'processing' | 'awaiting_provider' | 'succeeded' | 'failed' | 'cancelled' required
stage'resolve' | 'captions' | 'acquire_audio' | 'submit_asr' | 'wait_asr' | 'finalize' | 'null' nullable required

Current pipeline step while in flight; null once final.

result_idstring uuid nullable required

Transcript id once status is succeeded; fetch with GET /v1/transcripts/{id}. Null otherwise.

created_atstring date-time required

Submission time, UTC.

Changes

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