Get info on a specific Template

GET /jobs/templates/ID

Parameters

  • access_token: OAuth 2.0 API access token.
  • format: json or xml. This will override the Request Accept header.
  • human: true or false. Causes the response to be in a structured, more human-readable form. Useful when calling the API through curl or a browser.
  • expand_all: true or false. Recursively look up referenced objects (e.g. file) 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.
  • show_null: true or false. If set to "true", the response will contain also keys that are not set to a value.

Example

GET /jobs/templates/ID
curl "https://api.xvid.com/v1/jobs/templates/643ea464e77b9d03f98cff34?access_token=m9VmyJKTPGFqpkL_THjGE5rkXqfURDYqQ8MTBVidG3PtwkfABIdx6s_z9WlFl4_j&human=true"
{
  "template": {
    "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": "th_1080"
            }
          ],
          "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"
  }
}
  • No labels