Transcription Jobs

Cancel a transcription job

Cancels a queued/running job; idempotent on terminal jobs (returns them unchanged). This operation does not erase completed results, uploaded input objects, logs, or backups.

delete/v1/transcription/jobs/{id}

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/transcription/jobs/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Path parameters

idstring required

Response

Job

job_idstring required
status'queued' | 'running' | 'completed' | 'failed' | 'cancelled' required
created_atinteger required

Unix ms.

updated_atinteger required

Unix ms.

result_urlstring uri

Signed GET URL for an offloaded large result.

errorstring

Human-readable normalized failure message on failed jobs. This field is not a stable machine-readable failure code.

Example response

{
  "job_id": "job_aZ09...",
  "result": {
    "text": "[speaker_1] Hello everyone.",
    "audio_seconds": 120,
    "speakers": 1,
    "words": [
      {
        "word": "Hello",
        "start": 0.42,
        "end": 0.81,
        "confidence": 0.98,
        "speaker": "speaker_1",
        "channel": 0
      }
    ],
    "segments": [
      {
        "id": 0,
        "text": "Hello everyone.",
        "start": 0.42,
        "end": 1.8,
        "speaker": "speaker_1",
        "channel": 0
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.