View Source

List information about all Templates

GET /jobs/templates/

Parameters

start: offset for paging (optional)
limit: number of profile items per page (optional)
sort: The key by which to sort the result, e.g. "sort=created_at" to sort by creation date.
direction: Sort records in ascending ("1") or descending ("-1") order. Default value: "1".
format: json or xml. This will override the Request Accept header.
human: true or false. If true, will return the response in a structured, more human-readable form. Useful when calling the API through curl or from the browser.
pipeline.id: ID string. Filters results to return only templates matching the provided pipeline id.
expand_all: true or false. Recursively look up referenced objects (e.g. file id) and embed the respective json as a nested object directly into the response.
expand: Comma separated referenced objects (e.g. file,preset). Look up specified ids and embed the respective json as a nested object directly into the response.

Example

curl "https://api.xvid.com/v1/jobs/templates/?access_token=m9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j&human=true&limit=1"
{
  "templates": [
    {
      "name": "My Test Template",
      "job_settings": {
        "pipeline": {
          "id": "5eb43241e4b0463cfe034c1f",
          "href": "https://api.xvid.com/v1/pipelines/5eb43241e4b0463cfe034c1f"
        },
        "user_data": "My Personal Marker",
        "input": {
          "start_time": 0
        },
        "autograph": {
          "watermark_strength": "light"
        },
        "output_prefix": "{job_id}/",
        "outputs": [
          {
            "preset": {
              "id": "5e2834a2c35f386a1327c958",
              "href": "https://api.xvid.com/v1/presets/5e2834a2c35f386a1327c958"
            },
            "output_name": "{input_name}",
            "thumbnails": [
              {
                "thumbnail_names": "thumb_{resolution}",
                "thumbnail_preset": "thumb_small"
              }
            ],
            "logos": [
              {
                "logo_image": "https://s3-us-east-1.amazonaws.com/my_logo_pngs/logo30.png",
                "logo_preset": "logo_30_bottom_right"
              }
            ],
            "settings": {
              "video": {
                "height": "100%",
                "width": "100%",
                "bitrate": "90%"
              }
            }
          }
        ]
      },
      "version": 1,
      "user": {
        "id": "549c8069e4b0934ab39b4447",
        "href": "https://api.xvid.com/v1/users/549c8069e4b0934ab39b4447"
      },
      "created_at": 1681826916777,
      "updated_at": 1681826916665,
      "id": "643ea464e77b9d03f98cff34",
      "href": "https://api.xvid.com/v1/jobs/templates/643ea464e77b9d03f98cff34"
    }
  ],
  "total": 1,
  "start": 0,
  "limit": 1,
  "first": {
    "href": "https://api.xvid.com/v1/jobs/templates/?start=0&limit=1&human=true"
  },
  "last": {
    "href": "https://api.xvid.com/v1/jobs/templates/?start=0&limit=1&human=true"
  },
  "next": {
    "href": "https://api.xvid.com/v1/jobs/templates/?start=0&limit=1&human=true"
  },
  "prev": {
    "href": "https://api.xvid.com/v1/jobs/templates/?start=0&limit=1&human=true"
  }
}