API Documentation

Appearance

DELETE /pipelines/ID ​

Description ​

Deletes a pipeline by ID. The delete will succeed only when no ongoing job is still associated with the pipeline. Otherwise, an error is returned.

Authentication ​

  • Required: Yes
  • Method: Bearer token

Headers ​

  • Authorization: Bearer [AUTH_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 "https://api.xvid.com/v1/pipelines/54721f1ee4b09edbcfd16244?human=true" \
  -H "Authorization: Bearer AUTH_TOKEN" \
  -H "Content-Type: application/json"

Response ​

Success (200 OK) ​

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

Error Responses ​

400 Bad Request ​

json
{
  "error": {
    "error_code": "0x0170001",
    "error_message": "Invalid Input"
  }
}

403 Forbidden ​

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

404 Not Found ​

json
{
  "error": {
    "error_code": "0x0170002",
    "error_message": "Pipeline does not exist"
  }
}

500 Internal Server Error ​

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