API Documentation

Appearance

DELETE /jobs/ID ​

Description ​

Delete a job specified by ID. The behavior of this call depends on the status of the job:

  1. If the job specified by ID is not yet done (i.e., in QUEUED or PROCESSING state), the job is cancelled and no output files will be produced.
  2. If the job was already performed (i.e., in SUCCESS or FAILURE state), deleting the job will also delete all associated meta-data and binary data for the output files created as part of the job. Note that this includes the output files' contents (unless the output files were externally uploaded onto your own storage).

Authentication ​

  • Required: Yes
  • Method: Bearer token

Headers ​

  • Authorization: Bearer [token]
  • Accept:
    • application/json (for JSON responses)
    • application/xml (for XML responses)

Parameters ​

Query Parameters ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Request Accept header.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form.

Example Request ​

bash
curl -X DELETE -H "Authorization: Bearer AUTH_TOKEN" "https://api.xvid.com/v1/jobs/541db732e4b0eff926da9182?human=true"

Response ​

Success (200 OK) ​

json
{
  "result": {
    "status": "SUCCESS"
  }
}

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0050001",
    "error_message": "Invalid Input"
  }
}

403 Forbidden ​

json
{
  "error": {
    "error_code": "0x0000003",
    "error_message": "Invalid access token"
  }
}

404 Not Found ​

json
{
  "error": {
    "error_code": "0x0050005",
    "error_message": "Job does not exist"
  }
}

500 Internal Server Error ​

json
{
  "error": {
    "error_code": "0x0000001",
    "error_message": "Internal Error"
  }
}