Cancel Transcoding

Cancel a preparing Transcoding and release its unpaid reservation. Repeating an accepted cancellation succeeds.

POST

/transcodings/{transcodingId}/cancel

Authorization

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Path Parameters

transcodingId

string

required

TranscodingId identifies a Transcoding in the authenticated Project.

Responses

Cancellation accepted. The response body is empty.

application/json

error

object

required

status

"error"

string

required

Status indicates the response status "error"

Validation error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Forbidden error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

NotFound error

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

The Transcoding is ready or failed, or final publication has already started.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

TooManyRequests error

application/json

error

object

required

status

"error"

string

required

Unexpected error

import Chunkify from '@chunkify/chunkify';

const client = new Chunkify({
  projectAccessToken: 'My Project Access Token',
});

await client.transcodings.cancel('tcg_example');
from chunkify import Chunkify

client = Chunkify(
    project_access_token="My Project Access Token",
)
client.transcodings.cancel(
    "tcg_example",
)
<?php

use Chunkify\Client;

$client = new Client(
    projectAccessToken: 'My Project Access Token',
);

$client->transcodings->cancel('tcg_example');
package main

import (
	"context"

	"github.com/chunkifydev/chunkify-go"
	"github.com/chunkifydev/chunkify-go/option"
)

func main() {
	client := chunkify.NewClient(
		option.WithProjectAccessToken("My Project Access Token"),
	)
	err := client.Transcodings.Cancel(
		context.TODO(),
		"tcg_example",
	)
	if err != nil {
		panic(err.Error())
	}
}

No content
{
  "error": {
    "code": 400,
    "message": "Invalid request parameters",
    "type": "ValidationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 401,
    "message": "Authentication error: invalid token or subscription inactive",
    "type": "AuthenticationError"
  },
  "status": "error"
}
{
  "error": {
    "code": 403,
    "message": "Unauthorized to perform this action",
    "type": "ForbiddenError"
  },
  "status": "error"
}
{
  "error": {
    "code": 404,
    "message": "Ressource not found",
    "type": "NotFoundError"
  },
  "status": "error"
}
{
  "error": {
    "code": 409,
    "message": "source_unavailable: the original video is no longer accessible",
    "type": "ConflictError"
  },
  "status": "error"
}
{
  "error": {
    "code": 429,
    "message": "Rate limit exceeded",
    "type": "TooManyRequestsError"
  },
  "status": "error"
}
{
  "error": {
    "code": 500,
    "message": "Internal server error",
    "type": "UnexpectedError"
  },
  "status": "error"
}

# Cancel Transcoding > Cancel a preparing Transcoding and release its unpaid reservation. Repeating an accepted cancellation succeeds. ```json { "path": "/transcodings/{transcodingId}/cancel", "method": "post", "schema": { "description": "Cancel a preparing Transcoding and release its unpaid reservation. Repeating an accepted cancellation succeeds.", "operationId": "cancelTranscoding", "parameters": [ { "description": "TranscodingId identifies a Transcoding in the authenticated Project.", "in": "path", "name": "transcodingId", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Cancellation accepted. The response body is empty." }, "400": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorValidation" } } }, "description": "Validation error" }, "401": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorAuthentication" } } }, "description": "Authentication error" }, "403": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorForbidden" } } }, "description": "Forbidden error" }, "404": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorNotFound" } } }, "description": "NotFound error" }, "409": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorConflict" } } }, "description": "The Transcoding is ready or failed, or final publication has already started." }, "429": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorTooManyRequests" } } }, "description": "TooManyRequests error" }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResponseErrorUnexpected" } } }, "description": "Unexpected error" } }, "security": [ { "ProjectAccessToken": [] } ], "summary": "Cancel Transcoding", "tags": [ "Transcodings" ], "x-codeSamples": [ { "lang": "typescript", "source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nawait client.transcodings.cancel('tcg_example');" }, { "lang": "python", "source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\nclient.transcodings.cancel(\n \"tcg_example\",\n)" }, { "lang": "php", "source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$client-\u003etranscodings-\u003ecancel('tcg_example');" }, { "lang": "golang", "source": "package main\n\nimport (\n\t\"context\"\n\n\t\"github.com/chunkifydev/chunkify-go\"\n\t\"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n\tclient := chunkify.NewClient(\n\t\toption.WithProjectAccessToken(\"My Project Access Token\"),\n\t)\n\terr := client.Transcodings.Cancel(\n\t\tcontext.TODO(),\n\t\t\"tcg_example\",\n\t)\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n}\n" } ] } } ``` ```json #/components/schemas/ResponseErrorConflict { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 409, "description": "Code is the HTTP status code", "examples": [ 409 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "source_unavailable: the original video is no longer accessible" ], "type": "string" }, "type": { "const": "ConflictError", "description": "Type indicates the error category", "enum": [ "ConflictError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorTooManyRequests { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 429, "description": "Code is the HTTP status code", "examples": [ 429 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Rate limit exceeded" ], "type": "string" }, "type": { "const": "TooManyRequestsError", "description": "Type indicates the error category", "enum": [ "TooManyRequestsError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorUnexpected { "description": "Unexpected preview processing or storage failure.", "properties": { "error": { "properties": { "code": { "const": 500, "type": "integer" }, "message": { "examples": [ "Internal server error" ], "type": "string" }, "type": { "const": "UnexpectedError", "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorValidation { "properties": { "error": { "properties": { "code": { "const": 400, "description": "Code is the HTTP status code", "examples": [ 400 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Invalid request parameters" ], "type": "string" }, "type": { "const": "ValidationError", "description": "Type indicates the error category", "enum": [ "ValidationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorAuthentication { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 401, "description": "Code is the HTTP status code", "examples": [ 401 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Authentication error: invalid token or subscription inactive" ], "type": "string" }, "type": { "const": "AuthenticationError", "description": "Type indicates the error category", "enum": [ "AuthenticationError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ``` ```json #/components/schemas/ResponseErrorForbidden { "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 403, "description": "Code is the HTTP status code", "examples": [ 403 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Unauthorized to perform this action" ], "type": "string" }, "type": { "const": "ForbiddenError", "description": "Type indicates the error category", "enum": [ "ForbiddenError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ] } ``` ```json #/components/schemas/ResponseErrorNotFound { "description": "Error response", "properties": { "error": { "description": "Error response details", "properties": { "code": { "const": 404, "description": "Code is the HTTP status code", "examples": [ 404 ], "type": "integer" }, "message": { "description": "Message is a human-readable error description", "examples": [ "Ressource not found" ], "type": "string" }, "type": { "const": "NotFoundError", "description": "Type indicates the error category", "enum": [ "NotFoundError" ], "type": "string" } }, "required": [ "type", "code", "message" ], "type": "object" }, "status": { "const": "error", "description": "Status indicates the response status \"error\"", "type": "string" } }, "required": [ "status", "error" ], "type": "object" } ```