API Documentation

Appearance

GET /pipelines/[ID] ​

Description ​

Get information about pipelines. Supports fetching all pipelines or a specific pipeline by ID.

Authentication ​

  • Required: Yes
  • Method: Bearer token

Request Headers ​

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

Parameters ​

Query Parameters ​

Common Parameters (for both GET /pipelines/ and GET /pipelines/ID) ​

  • format: string (Optional)
    Values: json, xml
    Overrides the Accept header if provided.
  • human: boolean (Optional)
    Values: true, false
    Causes the response to be in a structured, more human-readable form.
  • show_null: boolean (Optional)
    Values: true, false
    If set to "true", the response will contain keys that are not set to a value.
  • expand_all: boolean (Optional)
    Values: true, false
    Recursively look up referenced objects and embed the respective JSON as nested objects directly into the response.
  • expand: string (Optional)
    Comma separated referenced objects (e.g. preset, user). Looks up objects referenced by ids and embed the respective JSON as nested objects directly into the response.

Parameters for Fetching Multiple Pipelines (GET /pipelines/) ​

  • start: int (Optional)
    Offset for paging. Default value: 0.
  • limit: int (Optional)
    Number of pipelines per page. Default value: 1000 (max: 5000).
  • sort: string (Optional)
    Values: Any valid key name
    Sorts the output along the given key name. For example, use created_at to sort the results by the creation date.
  • direction: string (Optional)
    Sort records in ascending ("1") or descending ("-1") order. Default value: "1".

Example Request for Listing Multiple Pipelines ​

bash
curl -X GET "https://api.xvid.com/v1/pipelines/?show_null=true&human=true&limit=2&sort=created_at&direction=-1" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example Response for Listing Multiple Pipelines ​

Success (200 OK) ​

json
{
  "pipelines": [
    {
      "name": "Seedbox S3 Pipeline",
      "description": null,
      "default_object_timeout": null,
      "cancel_timeout": null,
      "input_download_dir": "s3://AKIAYNAXREE5QGI4I2RR:****************************************@s3.amazonaws.com/forensicwatermarking/",
      "image_download_dir": "s3://AKIAYNAXREE5QGI4I2RR:****************************************@s3.amazonaws.com/forensicwatermarking/",
      "download_options": {
        "auto_convert_input": "off",
        "https_certificate_check": null
      },
      "output_upload_dir": null,
      "image_upload_dir": null,
      "upload_options": null,
      "store_options": null,
      "ping_urls": null,
      "edit_history": null,
      "enable_backtrace_pings": false,
      "file": {
        "id": "5ebd0c54e4b09851d4980a0a",
        "href": "https://api.xvid.com/v1/files/5ebd0c54e4b09851d4980a0a"
      },
      "version": 1,
      "user": {
        "id": "547f3eede4b025bcbff38655",
        "href": "https://api.xvid.com/v1/users/547f3eede4b025bcbff38655"
      },
      "created_at": 1589447764951,
      "updated_at": 1589447764951,
      "id": "5ebd0c54e4b09851d4980a09",
      "href": "https://api.xvid.com/v1/pipelines/5ebd0c54e4b09851d4980a09"
    },
    {
      "name": "Test Ping",
      "description": null,
      "default_object_timeout": null,
      "cancel_timeout": null,
      "input_download_dir": null,
      "image_download_dir": null,
      "download_options": {
        "auto_convert_input": "off",
        "https_certificate_check": null
      },
      "output_upload_dir": null,
      "image_upload_dir": null,
      "upload_options": null,
      "store_options": null,
      "ping_urls": {
        "error": "https://webhook.site/b1ad6c4e-8f01-41d0-b250-e23c8b26c666",
        "warning": "https://webhook.site/b1ad6c4e-8f01-41d0-b250-e23c8b26c666",
        "started": "https://webhook.site/b1ad6c4e-8f01-41d0-b250-e23c8b26c666",
        "finished": "https://webhook.site/b1ad6c4e-8f01-41d0-b250-e23c8b26c666"
      },
      "edit_history": null,
      "enable_backtrace_pings": false,
      "file": {
        "id": "5eb429c5e4b0bad2208c1456",
        "href": "https://api.xvid.com/v1/files/5eb429c5e4b0bad2208c1456"
      },
      "version": 1,
      "user": {
        "id": "547f3eede4b025bcbff38655",
        "href": "https://api.xvid.com/v1/users/547f3eede4b025bcbff38655"
      },
      "created_at": 1588865477147,
      "updated_at": 1689808926469,
      "id": "5eb429c5e4b0bad2208c1455",
      "href": "https://api.xvid.com/v1/pipelines/5eb429c5e4b0bad2208c1455"
    }
  ],
  "total": 12,
  "start": 0,
  "limit": 2,
  "first": {
    "href": "https://api.xvid.com/v1/pipelines/?start=0&limit=2&show_null=true&human=true&sort=created_at&direction=-1"
  },
  "last": {
    "href": "https://api.xvid.com/v1/pipelines/?start=10&limit=2&show_null=true&human=true&sort=created_at&direction=-1"
  },
  "next": {
    "href": "https://api.xvid.com/v1/pipelines/?start=2&limit=2&show_null=true&human=true&sort=created_at&direction=-1"
  },
  "prev": {
    "href": "https://api.xvid.com/v1/pipelines/?start=0&limit=2&show_null=true&human=true&sort=created_at&direction=-1"
  }
}

Example Request for Fetching a Specific Pipeline ​

bash
curl -X GET "https://api.xvid.com/v1/pipelines/547f3eede4b025bcbff38657?human=true&show_null=true" \
  -H "Authorization: Bearer AUTH_TOKEN"

Example Response for Fetching a Specific Pipeline ​

Success (200 OK) ​

json
{
  "pipeline": {
    "name": "Default Pipeline",
    "description": "Default Pipeline",
    "default_object_timeout": null,
    "cancel_timeout": null,
    "input_download_dir": null,
    "image_download_dir": null,
    "download_options": null,
    "output_upload_dir": null,
    "image_upload_dir": null,
    "upload_options": null,
    "store_options": null,
    "ping_urls": null,
    "edit_history": null,
    "enable_backtrace_pings": null,
    "file": {
      "id": "547f3eede4b025bcbff38659",
      "href": "https://api.xvid.com/v1/files/547f3eede4b025bcbff38659"
    },
    "version": 1,
    "user": {
      "id": "547f3eede4b025bcbff38655",
      "href": "https://api.xvid.com/v1/users/547f3eede4b025bcbff38655"
    },
    "created_at": 1417625325585,
    "updated_at": 1466796409346,
    "id": "547f3eede4b025bcbff38657",
    "href": "https://api.xvid.com/v1/pipelines/547f3eede4b025bcbff38657"
  }
}

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"
  }
}