Cancel a transcode job

Cancels a transcode job that is currently pending or processing. Completed, failed, or already-canceled jobs cannot be cancelled and return 400. If the job has been handed off to the toolkit service, a best-effort cancel is also sent to the toolkit — failures there are logged but do not fail this request.

patch/v1/transcodes/{id}/cancel

Request

  • Base URL: https://api.ffmpeg-micro.com
  • URL: https://api.ffmpeg-micro.com/v1/transcodes/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Job cancelled successfully

successboolean required
messagestring required

Example response

{
  "success": true,
  "message": "Job cancelled successfully",
  "job": {
    "id": "b5f5a9c0-9e33-4e77-8a5b-6a0c2cd9c0b3",
    "billable_minutes": 2.25,
    "duration_seconds": 135,
    "queue_position": 3,
    "ffmpeg_options": {
      "options": [
        {
          "option": "-c:v"
        }
      ]
    }
  }
}

Changes

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