Cancel a conversion

POST

/api/v1/convert/{fileId}/cancel

const url = 'https://api.gevell.com/api/v1/convert/example/cancel';
const options = {method: 'POST', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.gevell.com/api/v1/convert/example/cancel \
  --header 'X-API-Key: <X-API-Key>'

Stops the conversion and keeps the file; the reservation is released and nothing is charged. Same behaviour as POST /api/v1/files/{id}/cancel. 409 NOT_CANCELLABLE when nothing is in progress that can be stopped, CONVERSION_FINISHING once it is assembling its output.

Authorizations

apiKey

Parameters

Path Parameters

fileId

required

string

Responses

200

Cancelled

401

Missing or invalid API key

application/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}

404

Not found

application/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}

409

Not cancellable

application/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}

500

Unexpected error

application/json

object

success

boolean

error

object

code

string

message

string

details

object

key

additional properties

any

Example

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_CREDITS"
  }
}