jobs

Cancel before AssemblyAI submission starts

post/v1/jobs/{id}/cancel

Request

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

Path parameters

idstring uuid required

Response

Cancelled, or not allowed once submission started

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.